pakunok 0.0.1 → 0.0.2

data/.gitignore

@@ -5,3 +5,4 @@ pkg/
 spec/dummy/db/*.sqlite3
 spec/dummy/log/*.log
 spec/dummy/tmp/
+spec/dummy/public/assets/

data/Gemfile

@@ -1,14 +1,5 @@
 source "http://rubygems.org"
 
-gem 'rails', '3.1.0.rc5'
-gem 'sprockets', '2.0.0.beta13'
+gemspec
 
-# Bundle edge Rails instead:
-# gem 'rails',     :git => 'git://github.com/rails/rails.git'
-
-
-
-# To use debugger
-# gem 'ruby-debug19', :require => 'ruby-debug'
-
-gem 'rspec', :group => :test
+gem 'coffee-script', :require => false

data/Gemfile.lock

@@ -1,3 +1,11 @@
+PATH
+  remote: .
+  specs:
+    pakunok (0.0.2)
+      execjs
+      rails (>= 3.1.0.rc5)
+      sprockets (>= 2.0.0.beta13)
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -33,8 +41,14 @@ GEM
     arel (2.1.4)
     bcrypt-ruby (2.1.4)
     builder (3.0.0)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.1.2)
     diff-lcs (1.1.2)
     erubis (2.7.0)
+    execjs (1.2.4)
+      multi_json (~> 1.0)
     hike (1.2.0)
     i18n (0.6.0)
     mail (2.3.0)
@@ -93,6 +107,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  rails (= 3.1.0.rc5)
+  coffee-script
+  pakunok!
   rspec
-  sprockets (= 2.0.0.beta13)

data/HISTORY.md

@@ -0,0 +1,7 @@
+# 0.0.2 - 19 August 2011
+
+* Added haml-js as a new asset
+* Added the Tilt/Sprockets template for haml-js so it can be used from sprockets (autoregistered as `.hamljs`)
+
+# 0.0.2 - 14 August 2011
+Initial release. Includes assets that I often use.

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011 YOURNAME
+Copyright 2011 Dmytrii Nagirniak
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,57 +2,7 @@
 
 _Pakunok_ contains a set of prepackaged assets that you can easily include into your Rails 3.1 application (using assets pipeline).
 
-The list of the assets included (you can reference then using the name below prefixed with `pakunok/`:
-
-- jquery (defaults to 1.6.2)
-  - jquery/jquery-1.6.2
-  - jquery/jquery-1.5.2
-- jquery.validate
-- colorpicker (has CSS)
-- fileuploader (has CSS)
-- innershiv
-- jquery.form
-- jquery.validate
-- jquery.jscrollpane (has CSS)
-- jquery.mousewheel (optional improvement for jquery.jscrollpane)
-- mwheelIntent  (optional improvement for jquery.jscrollpane)
-- jquery.viewport
-- jquery-ui - standalone files (`jquery-ui/`): no dependencies tracked, serve these when part of jQueryUI has already been included elsewhere
-  - accordion
-  - autocomplete
-  - button
-  - core
-  - datepicker
-  - dialog
-  - draggable
-  - droppable
-  - effects (all effects, does not require jQuery-UI core)
-  - mouse
-  - position
-  - progressbar
-  - resizable
-  - selectable
-  - slider
-  - sortable
-  - tabs
-  - widget
-- jquery-ui -  combined (`jquery-ui/pack/`): ready-to-go options, you can include multiple into only one script file
-  - accordion
-  - autocomplete
-  - basic (includes core, widget, position, mouse components)
-  - button
-  - datepicker
-  - dialog
-  - draggable
-  - droppable
-  - effects (same as standalone)
-  - progressbar
-  - resizable
-  - selectable
-  - slider
-  - sortable
-  - tabs
-
+You can see all the included [assets](assets.md). (reference those prefixed with `pakunok/`):
 
 Tested on MRI Ruby 1.9.2.
 
@@ -71,12 +21,11 @@ Then `bundle install`.
 
 # Usage
 
-You can reference the assets as usually using the sprockets.
-Let's see full example (includes everything for the sake of demo):
-
+Reference as you normally do with Sprockets.
+Let's see some examples:
 
 
-## JavaScript Only libraries
+## JavaScript-only libraries
 
 You can simply reference plain JS libraries that do not require other assets (CSS, images) like this:
 
@@ -91,7 +40,7 @@ You can simply reference plain JS libraries that do not require other assets (CS
 
 //= require 'pakunok/innershiv'
 
-// jQuery plug-ins do no automatically include jQuery to allow to use them as a separate script tag
+// jQuery plug-ins do no depend on jQuery to allow using as a separate HTTP resource
 //= require 'pakunok/jquery.form'
 //= require 'pakunok/jquery.jscrollpane'
 //= require 'pakunok/jquery.mousewheel'
@@ -103,8 +52,6 @@ You can simply reference plain JS libraries that do not require other assets (CS
 //= require 'pakunok/jquery.viewport'
 ```
 
-It is also possible to reference the assets directly from the views.
-
 ## Libraries with related resources
 
 If the library has a related CSS file, then it can be included into your CSS (or served as a separate file).
@@ -122,26 +69,23 @@ It is named after the JavaScript library.
 
 # Precompilation
 By default Rails precompiles all the assets of all included libraries.
-This means that ALL of the assets will be compiled (although you only use part of it).
+This means that _ALL_ of the assets will be compiled (although you rarely need that).
 
-Please run `RAILS_ENV=production bundle exec rake assets:clean assets:precompile && tree public/assets` to verify necessary assets.
+Please run `RAILS_ENV=production bundle exec rake assets:clean assets:precompile && tree public/assets` to verify necessary files.
 
-It is recommended to change the default behaviour so that you know which assets are compiled:
+It is recommended to change the default behaviour so that you are not precompiling assets that the application will never use:
 
 ```ruby
 # config/application.rb
 
-# Something like this is the default
+# Something like this is the Rails default
 #config.assets.precompile = [/\w+\.(?!js|css).+/, /application.(css|js)$/]
 
 # Recommended: Explicitly add assets that you use (colorpicker),
 #  so that images and styles are available.
 config.assets.precompile = [/application.(css|js)$/, /pakunok\/colorpicker/]
 
-# Specify precompilable assets explicitly if you don't reference any assets from pakunok
-config.assets.precompile = [/application.(css|js)$/, 'expclicit-file.js', 'pakunok/colorpicker']
-
-# Exclude all pakunok assets from precompilation (it's ok if you reference only JS)
+# Exclude all pakunok assets from precompilation (it's ok if you don't have direct HTTP request to them)
 config.assets.precompile = [/(!pakunok)\w+\.(?!js|css).+/, /application.(css|js)$/]
 
 # Exclude all pakunok assets, but explicitly add ones that you use (colorpicker),
@@ -160,9 +104,81 @@ All the files under `pakunok/jquery-ui/*` do not automatically include depndenci
 But if you want to include all the dependencies into a single file, then use `pakunok/jquery-ui/pack/*`.
 
 
+# HAML for client side templating
+_Pakunok_ provides a new templating engine for Rails 3.1 that can be used to produce JavsScript templates.
+
+What you need to do is to use `.hamljs` extension on a javascript file with the HAML content.
+It will generate a plain optimised JavaScipt function that you can use on the client.
+
+For example, assuming you have a file `app/assets/javascripts/comment.js.hamljs` with the content:
+
+```haml
+.comment
+  .text= text
+  .author= author  
+```
+
+Then you can `require comment` from the `application.js`.
+This gives you access to `JST.comment` function allowing you to write JavaScript like:
+
+```javascript
+var html = JST.comment({author: 'Dima', text: 'Awesome'});
+$("#commit").append(html)
+```
+
+*NOTE*: [HAML-JS](https://github.com/creationix/haml-js) is a little bit different from the original HAML for Ruby.
+
+In case _pakunok_ could magically provide a good name for your template function, you can access it as `JST['what ever it is!']`.
+The name of the template function is derrived from the file name. Some examples for you:
+
+```
+  file                      => file
+  file.js.erb.hamljs        => file
+  file-with-dash.hamljs     => fileWithDash
+  file_with_underscore      => fileWithUnderscore
+  dir/foo_bar               => dir_fooBar
+  win\dir\foo_bar           => win_dir_fooBar
+  d1/d2/foo_bar.js.a.b.c.d  => d1_d2_fooBar
+```
+
+Yes, it uses one global variable `JST` to add all the functions but you can change it (see example further).
+
+_Pakunok_ will escape the HTML using simple built-in function.
+The escaping function is generated inside each template resulting in larger JavaScript code base.
+It is *highly* recommended to set it to your own when you have more than a couple of templates.
+
+
+## HAML Configuration options
+
+```ruby
+# Somewhere in your app...
+require 'pakunok/haml_js_template'
+
+# Change the escapeHTML function
+Pakunok::HamlJsTemplate.custom_escape = 'YourApp.html_escape' # default is nil - built-in
+
+# Change the global variable to attach templates to
+Pakunok::HamlJsTemplate.root_variable = 'Templates'  # default is 'JST'
+
+
+# Change the prefix from where to start naming the templates
+Pakunok::HamlJsTemplate.name_prefix = 'javascripts/templates'  # default is 'javascripts/'
+# This option will automatically be set to 'backbone/templates/' if back
+```
+
+When option `name_prefix` is not set and [rails-backbone](https://github.com/codebrew/backbone-rails) is available then `backbone/templates/` is used by default.
+
+
 # Development
 
 - Source hosted at [GitHub](https://github.com/dnagir/pakunok)
 - Report issues and feature requests to [GitHub Issues](https://github.com/dnagir/pakunok/issues)
 
 Pull requests are very welcome! But please write the specs.
+
+To start, clone the repo and then:
+
+```shell
+bundle install
+bundle exec rspec spec/
+```

data/assets.md

@@ -0,0 +1,51 @@
+List of all the assets that can be served (reference those prefixed with `pakunok/`)
+
+- haml (also includes Rails 3.1 precompilation)
+- jquery (defaults to 1.6.2)
+  - jquery/jquery-1.6.2
+  - jquery/jquery-1.5.2
+- jquery.validate
+- colorpicker (has CSS)
+- fileuploader (has CSS)
+- innershiv
+- jquery.form
+- jquery.validate
+- jquery.jscrollpane (has CSS)
+- jquery.mousewheel (optional improvement for jquery.jscrollpane)
+- mwheelIntent  (optional improvement for jquery.jscrollpane)
+- jquery.viewport
+- jquery-ui - standalone files (`jquery-ui/`): no dependencies tracked, serve these when part of jQueryUI has already been included elsewhere
+  - accordion
+  - autocomplete
+  - button
+  - core
+  - datepicker
+  - dialog
+  - draggable
+  - droppable
+  - effects (all effects, does not require jQuery-UI core)
+  - mouse
+  - position
+  - progressbar
+  - resizable
+  - selectable
+  - slider
+  - sortable
+  - tabs
+  - widget
+- jquery-ui -  combined (`jquery-ui/pack/`): ready-to-go options, you can include multiple into only one script file
+  - accordion
+  - autocomplete
+  - basic (includes core, widget, position, mouse components)
+  - button
+  - datepicker
+  - dialog
+  - draggable
+  - droppable
+  - effects (same as standalone)
+  - progressbar
+  - resizable
+  - selectable
+  - slider
+  - sortable
+  - tabs

data/lib/pakunok.rb

@@ -1,4 +1,12 @@
 module Pakunok
   class Engine < Rails::Engine
+    initializer "pakunok.configure_rails_initialization" do |app|
+      next unless app.config.assets.enabled
+
+      require 'sprockets'
+      require 'sprockets/engines'
+      require 'pakunok/haml_js_template'
+      Sprockets.register_engine '.hamljs', ::Pakunok::HamlJsTemplate
+    end
   end
 end

data/lib/pakunok/haml_js_template.rb

@@ -0,0 +1,83 @@
+require 'tilt/template'
+
+module Pakunok
+  class HamlJsTemplate < Tilt::Template
+    self.default_mime_type = 'application/javascript'
+
+
+    def self.engine_initialized?
+      defined? ::ExecJS
+    end
+
+    def initialize_engine
+      require_template_library 'execjs'
+    end
+
+    
+    def prepare
+    end
+
+
+    def evaluate(scope, locals, &block)
+      ns = self.class.root_variable || 'JST'
+      @output ||= <<-TEMPLATE
+(function(scope){
+  (scope.#{ns} || (scope.#{ns} = {}))['#{client_name}'] = #{compile_to_function};
+})(this);
+        TEMPLATE
+    end
+
+
+    def client_name
+      prefix = self.class.name_prefix || if defined?(BackboneRails)
+        'backbone/templates/'
+      else
+        'javascripts/'
+      end
+      path = eval_file
+      name_start = path.rindex(prefix)
+      path = file[(name_start + prefix.length)..-1] if name_start
+
+
+      parts = path.split(/-|_/)
+      res = parts[0] + (parts[1..-1] || []).map {|w| w.capitalize }.join
+      res = res.gsub(/\/|\\/, '_')
+      res.split('.').first.sub(/^_/, '') # chomp of the extensions
+    end
+
+
+    def compile_to_function
+      function = ExecJS.
+        compile(self.class.haml_source).
+        eval "Haml('#{js_string data}', {escapeHtmlByDefault: true, customEscape: #{js_custom_escape}}).toString()"
+      # make sure function is annonymous
+      function.sub /function \w+/, "function "
+    end
+
+
+    def js_string str
+      (str || '').
+        gsub("'")  {|m| "\\'" }.
+        gsub("\n") {|m| "\\n" }
+    end
+
+
+    def js_custom_escape
+      self.class.custom_escape ? "'#{js_string self.class.custom_escape}'" : 'null'
+    end
+
+
+    class << self
+      attr_accessor :custom_escape
+      attr_accessor :root_variable
+      attr_accessor :name_prefix
+
+      def haml_source
+        # Haml source is an asset
+        @haml_source ||= IO.read File.expand_path('../../../vendor/assets/javascripts/pakunok/haml.js', __FILE__) 
+      end
+    end
+
+  end
+end
+

data/lib/pakunok/version.rb

@@ -1,5 +1,5 @@
 module Pakunok
   module Version
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/pakunok.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency             'rails', '>= 3.1.0.rc5'
   s.add_dependency             'sprockets', '>= 2.0.0.beta13'
+  s.add_dependency             'execjs'
   s.add_development_dependency 'rspec'
 
   s.files         = `git ls-files`.split("\n")