chrome_packager 0.0.6 → 0.0.7

data/README.md

@@ -0,0 +1,79 @@
+# Chrome packager: a simple tool to create chrome packaged applications
+
+Don't you know what a chrome packaged application is? [read this first](http://developer.chrome.com/trunk/apps/about_apps.html).
+
+Chrome packager brings all the goodness of the [Rails asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html) but without Rails, this is intended to write pure javascript applications.
+
+What you can do with chrome packager:
+
+- Write your apps as if you were writing it in the Rails asset pipeline
+- Write your app with coffescript
+- Write your stylesheets using sass
+- Write your templates with hamljs(This is fixed now, but in the future you'll be able to use any sprockets compatible template engine)
+- Once your app is ready, you can pack it with one command
+
+## Installation
+
+Install chrome packager form RubyGems:
+
+	gem install chrome_packager
+
+## Creating a new application
+
+Once you have installed the gem:
+	
+	chrome-packager new [your app name]
+	
+You'll have the following file structure
+
+	-app
+	  -assets
+		-javascripts
+		  - application.js
+		-stylesheets
+		  - application.css
+	  -views
+	    - index.haml
+	- background.js
+	- manifest.json
+	- config.ru
+	- Gemfile
+	- Gemfile.lock
+	
+Start writing your application, application.js and application.css are manifest files, you can use the [sprockets directive processor](https://github.com/sstephenson/sprockets#the-directive-processor) here, so you can manage your dependencies easily.
+
+You must write your basic html inside the app/views/index.haml file, this is supposed to be a single page application so you don't need more files, all the markup should be inside javascript templates.
+
+You'll also want to modify the [manifest.json](http://developer.chrome.com/trunk/apps/manifest.html) and [background.js](http://developer.chrome.com/trunk/apps/app_lifecycle.html) file to fix your needs.
+
+## Running the application
+
+Chrome packager creates a rack application, you only need to run this command:
+
+	rackup
+
+After this, your application should be running in the 9292 port, now you can open it in your browser with the following url:
+
+	http://localhost:9292/
+
+## Packing
+
+Once you are done with your app or you want to try it as a chrome app, you have to pack it. Run the following command in the root of your app:
+
+	chrome-packager pack
+	
+This command will compile all your javascripts and css's and will put them in the packaged dir.
+
+After this just follow [this instructions](http://developer.chrome.com/trunk/apps/first_app.html#five) and point chrome to your app dir.
+
+## TODO
+- Compile the index.haml view to html
+- Integrate [Jasmine](http://pivotal.github.com/jasmine/)
+- Every config is fixed now, add way to config the app will be good	
+	
+## Contributing
+
+I made this in one night, so I'm sure there will be bugs, feel free to fork and send a pull request.
+
+
+ 

data/bin/chrome-packager

@@ -6,11 +6,24 @@ require 'haml-sprockets'
 require 'thor/group'
 require 'thor/actions'
 require 'fileutils'
+require 'haml'
 
 class Generator < Thor::Group
   include Thor::Actions
 end
 
+module Haml
+  module Helpers
+    def stylesheet_link_tag(asset)
+      "<link href='/stylesheets/#{asset}.css' media='screen' rel='stylesheet' type='text/css'>"
+    end
+
+    def javascript_include_tag(asset)
+      "<script src='/javascripts/#{asset}.js'></script>"
+    end
+  end
+end
+
 Generator.source_root File.expand_path('../lib/templates', File.dirname(__FILE__))
 
 def pack
@@ -24,6 +37,7 @@ def pack
     environment.find_asset("#{Dir.pwd}/app/assets/javascripts/application.js").to_s
   generator.create_file 'packaged/stylesheets/application.css',
     environment.find_asset("#{Dir.pwd}/app/assets/javascripts/application.css").to_s
+  generator.create_file 'packaged/index.html', parse_index
 end
 
 def create_new_app(name)
@@ -45,6 +59,11 @@ def create_new_app(name)
   end
 end
 
+def parse_index
+  file = File.read "#{Dir.pwd}/app/views/index.haml"
+  Haml::Engine.new(file).render
+end
+
 case
 when ARGV[0] == 'new'
   if ARGV.size == 2 && !ARGV[1].empty?

data/chrome_packager.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'chrome_packager'
-  s.version     = '0.0.6'
+  s.version     = '0.0.7'
   s.date        = '2012-09-23'
   s.summary     = "Create packaged chrome apps"
   s.description = "A simple tool to create packaged chrome apps"

data/lib/chrome_packager/application.rb

@@ -1,6 +1,18 @@
 require 'haml'
 require 'sinatra'
 
+module Haml
+  module Helpers
+    def stylesheet_link_tag(asset)
+      "<link href='/assets/#{asset}.css' media='screen' rel='stylesheet' type='text/css'>"
+    end
+
+    def javascript_include_tag(asset)
+      "<script src='/assets/#{asset}.js'></script>"
+    end
+  end
+end
+
 module ChromePackager
   class Application < Sinatra::Base
     set :root, 'app'

data/lib/chrome_packager/version.rb

@@ -1,3 +1,3 @@
 module ChromePackager
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/lib/templates/index.haml

@@ -2,7 +2,7 @@
 %html
   %head
     %title Chrome packaged app
-    %script{ src: '/assets/application.js' }
-    %link{ rel: 'stylesheet', href: '/assets/application.css', type: 'text/css', media: 'screen' }
+    = javascript_include_tag 'application'
+    = stylesheet_link_tag 'application'
   %body
     %h1 Hello world

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chrome_packager
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - bin/chrome-packager
 - chrome_packager.gemspec