confetti 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+tmp/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in confetti.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    confetti (0.1.0)
+      mustache (= 0.11.2)
+      thor (= 0.14.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.2.6)
+      background_process
+      cucumber (~> 0.9.4)
+    background_process (1.2)
+    builder (2.1.2)
+    cucumber (0.9.4)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    mustache (0.11.2)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    term-ansicolor (1.0.5)
+    thor (0.14.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  confetti!
+  cucumber
+  mustache (= 0.11.2)
+  rspec (~> 2.1.0)
+  thor (= 0.14.3)

data/README.md

@@ -0,0 +1,46 @@
+# Confetti
+
+## How to Add a New Platform
+
+Let's say you want write a `nintendo_ds_config` generator:
+
+* create a feature file, like `features/nintendo.feature`
+  * specify all the files to generate for your platform
+  * specify the name each file will go under
+    * `nintendo_ds_config`
+  * and the default filename
+    * `NintendoDSConfig.xml`
+  * run `rake features` to verify that it fails
+* add a sample configuration file to `spec/fixtures`
+  * the filename is based on the descriptive name
+    * `nintendo_ds_config_expected.xml`
+* add some failing specs
+  * copy one of the existing specs from `spec/templates`
+    * `cp android_manifest_spec.rb nintendo_ds_config_spec.rb`
+  * modify the new file to match your new template
+    * this isn't as well automated as we'd like
+  * run `rake spec` to verify that they fail
+* create your view class
+  * as `lib/confetti/templates/nintendo_ds_config.rb`
+  * should define `Confetti::Template::NintendoDsConfig < Base`
+* create your template file
+  * copy your expected config into `lib/confetti/templates`
+    * as `nintendo_ds_config.mustache`
+  * replace the variable sections with mustache tags
+* in your view class
+  * write methods that correspond to the variable sections in your template
+* run `rake spec` to ensure everything was set up correctly
+* add specs for generate and write methods
+  * open `spec/config_spec.rb`
+  * add the following line to the `describe config generation` block
+    * `it_should_have_generate_and_write_methods_for :nintendo_ds_config`
+* run `rake spec`, see them fail
+* add generate and write methods
+  * open lib/confetti/config.rb
+  * add your platform to the `generate_and_write` call
+    * `generate_and_write ... :nintendo_ds_config`
+* run `rake spec` again
+* build and install the gem, or whatever, so the cucumber tests work
+* run `feature/nintendo.feature`
+  * it's all green!
+  * you're the man now dog

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "run all specs"
+task :spec do
+ system "bundle exec rspec spec"
+end
+
+desc "run all cucumber features"
+task :features do
+  system "bundle exec cucumber features"
+end
+
+namespace :spec do
+  # more spec running tasks here
+  # whenever
+end
+
+task :default => [:features, :spec]

data/bin/confetti

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "confetti/cli"
+Confetti::CLI.start

data/confetti.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "confetti/version"
+
+Gem::Specification.new do |s|
+  s.name        = "confetti"
+  s.version     = Confetti::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Lunny"]
+  s.email       = ["alunny@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/confetti"
+  s.summary     = %q{Generate mobile app config files}
+  s.description = %q{ A little library to generate platform-specific mobile app
+                      configuration files from a W3C widget spec compliant config.xml}
+
+  s.rubyforge_project = "confetti"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "mustache", "0.11.2"
+  s.add_dependency "thor", "0.14.3"
+
+  s.add_development_dependency "rspec", "~> 2.1.0"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
+end

data/features/android.feature

@@ -0,0 +1,14 @@
+Feature: Android
+	In order to build Android Apps
+	As a Mobile Developer
+	I want to generate Android configuration files
+
+	Scenario: I need an AndroidManifest
+		When I have a config.xml file
+		And I run "confetti generate android_manifest"
+		Then a file named "AndroidManifest.xml" should exist
+
+	Scenario: I need an Android strings.xml file
+		When I have a config.xml file
+		And I run "confetti generate android_strings"
+		Then a file named "strings.xml" should exist

data/features/blackberry.feature

@@ -0,0 +1,9 @@
+Feature: Blackberry
+  In order to build Blackberry Apps
+	As a Mobile Developer
+  I want to generate whatever config files are required
+
+	Scenario: I need a (BB widget) config.xml
+		When I have a config.xml file
+		And I run "confetti generate blackberry_widgets_config"
+		Then a file named "bb-config.xml" should exist

data/features/command_line.feature

@@ -0,0 +1,12 @@
+Feature: Command Line
+  In order to generate mobile configurations
+  As a PhoneGap Developer
+  I want to use the Confetti CLI
+
+  Scenario: I want an unsupported type
+    When I have a config.xml file
+    And I run "confetti generate microsoft_word"
+    Then it should fail with:
+      """
+      microsoft_word unsupported
+      """

data/features/ios.feature

@@ -0,0 +1,9 @@
+Feature: iOS
+	In order to build iOS Apps
+	As a Mobile Developer
+	I want to generate the iOS configuration files
+
+	Scenario: I need an Info.plist
+		When I have a config.xml file
+		And I run "confetti generate ios_info"
+		Then a file named "Info.plist" should exist

data/features/step_definitions/aruba_ext_steps.rb

@@ -0,0 +1,7 @@
+When /^I have a config.xml file$/ do
+  fixtures_dir = File.join(File.dirname(__FILE__), '..', '..', 'spec', 'fixtures')
+  fixtures_dir = File.expand_path(fixtures_dir)
+  config_fixture = File.read(File.join(fixtures_dir, "config.xml"))
+
+  create_file("config.xml", config_fixture)
+end

data/features/support/setup.rb

@@ -0,0 +1 @@
+require "aruba"

data/features/symbian.wrt.feature

@@ -0,0 +1,9 @@
+Feature: Symbian.wrt
+  In order to build Symbian.wrt Apps
+	As a Mobile Developer
+  I want to generate the Symbian.wrt configuration files
+
+	Scenario: I need an info.plist
+		When I have a config.xml file
+		And I run "confetti generate symbian_wrt_info"
+		Then a file named "info.plist" should exist

data/features/webos.feature

@@ -0,0 +1,9 @@
+Feature: webOS
+	In order to build webOS Apps
+	As a Mobile Developer
+	I want to generate the webOS configuration files
+
+	Scenario: I need a appinfo.json
+		When I have a config.xml file
+		And I run "confetti generate webos_appinfo"
+		Then a file named "appinfo.json" should exist

data/lib/confetti.rb

@@ -0,0 +1,31 @@
+CURRENT_DIR = File.dirname(__FILE__)
+
+# stdlib
+require "rexml/document"
+
+# external dependencies
+begin
+  require "bundler/setup"
+rescue LoadError
+  require "rubygems"
+  require "bundler/setup"
+end
+
+require "thor"
+require "mustache"
+
+# internal dependencies
+require 'typedset'
+require 'confetti/version'
+require 'confetti/helpers'
+
+require 'confetti/template'
+require 'confetti/templates/base'
+require 'confetti/templates/java_checks'
+Dir[File.join(CURRENT_DIR, 'confetti', 'templates', '*')].each do |file|
+  require file if File.extname(file) == ".rb"
+end
+require 'confetti/template_helper'
+
+require 'confetti/config'
+require 'confetti/config/feature'

data/lib/confetti/cli.rb

@@ -0,0 +1,19 @@
+require "confetti"
+
+module Confetti
+  class CLI < Thor
+    desc "generate OUTPUT_FILE", "Generates a config file of type OUTPUT_FILE"
+    def generate(output_file)
+      config_xml = File.join(Dir.pwd, "config.xml")
+
+      config = Confetti::Config.new(config_xml)
+      msg = "write_#{ output_file }".to_sym
+
+      begin
+        config.send msg
+      rescue
+        fail "Confetti Failed: format #{ output_file } unsupported"
+      end
+    end
+  end
+end

data/lib/confetti/config.rb

@@ -0,0 +1,57 @@
+module Confetti
+  class Config
+    include Helpers
+    self.extend TemplateHelper
+
+    attr_accessor :package, :version, :description, :height, :width
+    attr_reader :author, :viewmodes, :name, :license, :content, 
+                :icon_set, :feature_set, :preference_set
+
+    generate_and_write  :android_manifest, :android_strings, :webos_appinfo,
+                        :ios_info, :symbian_wrt_info, :blackberry_widgets_config
+
+    # classes that represent child elements
+    Author      = Class.new Struct.new(:name, :href, :email)
+    Name        = Class.new Struct.new(:name, :shortname)
+    License     = Class.new Struct.new(:text, :href)
+    Content     = Class.new Struct.new(:src, :type, :encoding)
+    Icon        = Class.new Struct.new(:src, :height, :width)
+    Feature     = Class.new Struct.new(:name, :required)
+    Preference  = Class.new Struct.new(:name, :value, :readonly)
+
+    def initialize(*args)
+      @author           = Author.new
+      @name             = Name.new
+      @license          = License.new
+      @content          = Content.new
+      @icon_set         = TypedSet.new Icon
+      @feature_set      = TypedSet.new Feature
+      @preference_set   = TypedSet.new Preference
+      @viewmodes        = []
+
+      if args.length > 0 && is_file?(args.first)
+        populate_from_xml args.first
+      end
+    end
+
+    def populate_from_xml(xml_file)
+      config_doc = REXML::Document.new(File.read(xml_file)).root
+      fail "no doc parsed" unless config_doc
+
+      @package = config_doc.attributes["id"]
+      @version = config_doc.attributes["version"]
+
+      config_doc.elements.each do |ele|
+        case ele.name
+        when "name"
+          @name = Name.new(ele.text.strip, ele.attributes["shortname"])
+        when "author"
+          @author = Author.new(ele.text.strip, ele.attributes["href"], 
+                               ele.attributes["email"])
+        when "description"
+          @description = ele.text.strip
+        end
+      end
+    end
+  end
+end

data/lib/confetti/config/feature.rb

@@ -0,0 +1,13 @@
+module Confetti
+  class Config
+    class Feature
+      attr_reader :param_set
+
+      Param = Class.new
+
+      def initialize
+        @param_set = TypedSet.new Param
+      end
+    end
+  end
+end

data/lib/confetti/helpers.rb

@@ -0,0 +1,7 @@
+module Confetti
+  module Helpers
+    def is_file? (filename)
+      File.exist? filename
+    end
+  end
+end

data/lib/confetti/template.rb

@@ -0,0 +1,4 @@
+module Confetti
+  module Template
+  end
+end

data/lib/confetti/template_helper.rb

@@ -0,0 +1,28 @@
+module Confetti
+  module TemplateHelper
+    def generate_and_write (*platforms)
+      platforms.each do |config_type|
+        class_name = config_type.to_s.split("_").collect do |s|
+          s.capitalize
+        end.join
+        template_class = Confetti::Template.const_get(class_name)
+
+        generate_method = "generate_#{ config_type }".to_sym
+        write_method    = "write_#{ config_type }".to_sym
+
+        send :define_method, generate_method do
+          template_class.new(self)
+        end
+
+        send :define_method, write_method do |*args|
+          filepath = args.first
+
+          template = send generate_method
+          filepath ||= File.join(Dir.pwd, template.output_filename)
+
+          open(filepath, 'w') { |f| f.puts template.render }
+        end
+      end
+    end
+  end
+end

data/lib/confetti/templates/android_manifest.mustache

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="{{ package_name }}"
+    android:versionName="{{ version }}"
+    android:versionCode="1">
+    <uses-permission android:name="android.permission.CAMERA" />
+    <uses-permission android:name="android.permission.VIBRATE" />
+    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
+    <uses-permission android:name="android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />
+    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.RECEIVE_SMS" />
+    <uses-permission android:name="android.permission.RECORD_AUDIO" />
+    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+    <uses-permission android:name="android.permission.READ_CONTACTS" />
+    <uses-permission android:name="android.permission.WRITE_CONTACTS" />   
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />   
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    
+    <application android:icon="@drawable/icon" android:label="@string/app_name"
+    	android:debuggable="true">
+        <activity android:name=".{{ class_name }}"
+                  android:label="@string/app_name" android:configChanges="orientation|keyboardHidden">
+            <intent-filter>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
+            </intent-filter>
+        </activity>
+    </application>
+	<uses-sdk android:minSdkVersion="2" />
+
+</manifest>