coffeekup_rails 0.0.1

data/.gitignore

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,44 @@
+#CoffeeKup Rails
+CoffeeKup Rails is an asset pipeline engine/preprocessor for [coffeekup](http://coffeekup.org/) template files.
+Simply place your coffeekup templates in a configured asset directory with a .js.ck extension and they will be automatically available as precompiled js templates.
+##Example
+Say your client side views live in `/app/assets/javascripts/views` (default).
+
+Given `/app/assets/javascripts/views/shared/hello.js.ck`:
+
+    h1 "Hello #{@name}."
+
+CoffeeKup will automatically compile the coffeescript source to a coffeekup javascript template under a desired 
+global js object (defaults to `window.templates`). Template names are period delimited by directory structure:
+
+From the javascript console:
+
+    templates['shared.hello']({name: 'chris'})
+    => "<h1>Hello chris.</h1>"
+
+This happens upon every page load when your .ck files change thanks to sprockets and the asset pipeline just as you would expect for a .coffee file.
+
+## Installation
+  1. First grab [node.js](http://nodejs.org/#download) and [npm](https://github.com/isaacs/npm)
+  2. `npm install coffeekup -g`
+  3. `gem 'coffeekup_rails', :git => "git://github.com/chrismccord/coffeekup_rails.git"` and `bundle`
+
+Will be pushed to rubygems soon.
+
+### Initializer
+Configuration optional (defaults are redundantly set here); however, `Coffeekup.register_engine` must be included.
+
+    app/config/initializers/coffeekup.rb:
+    
+    Coffeekup.configure do |config|
+      config.namespace = 'templates'
+      config.extension = 'ck'
+    end
+
+    Coffeekup.register_engine
+
+## Configuration
+    Coffeekup.configure do |config|
+      config.namespace = 'name_of_global_js_object'  # default 'templates'
+      config.extension = 'coffeekup'                 # default 'ck'
+    end

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/coffeekup.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "coffeekup/version"
+
+Gem::Specification.new do |s|
+  s.name        = "coffeekup_rails"
+  s.version     = Coffeekup::VERSION
+  s.authors     = ["Chris McCord"]
+  s.email       = ["chris@chrismccord.com"]
+  s.homepage    = "https://github.com/chrismccord/coffeekup_rails"
+  s.summary     = %q{Asset pipeline engine/preprocessor for CoffeeKup template files}
+  s.description = %q{CoffeeKup Rails is an asset pipeline engine/preprocessor for CoffeeKup template files.}
+
+  s.rubyforge_project = "coffeekup_rails"
+
+  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"]
+end

data/lib/coffeekup/configuration.rb

@@ -0,0 +1,31 @@
+module Coffeekup
+  module Configuration
+
+    # Global frontend object name holding the templates
+    DEFAULT_NAMESPACE = 'templates'
+    # Base view directory where .ck templates will live
+    DEFAULT_BASE_DIRECTORY = "app/assets/javascripts/views"
+    # Extensions to use for Coffeekup files
+    DEFAULT_EXTENSION = "ck"
+
+    attr_accessor :namespace,
+                  :base_directory,
+                  :extension,
+                  :files
+    
+    # set all configuration options to their default values
+    def self.extended(base)
+      base.reset
+    end
+    
+    def configure
+      yield self
+    end
+    
+    def reset
+      self.namespace         = DEFAULT_NAMESPACE
+      self.base_directory    = DEFAULT_BASE_DIRECTORY
+      self.extension         = DEFAULT_EXTENSION
+    end
+  end
+end

data/lib/coffeekup/errors.rb

@@ -0,0 +1,15 @@
+module Coffeekup
+
+  class Error < StandardError
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+  
+  class CompilationError < Error
+  end
+  
+end

data/lib/coffeekup/version.rb

@@ -0,0 +1,3 @@
+module Coffeekup
+  VERSION = "0.0.1"
+end

data/lib/coffeekup_rails.rb

@@ -0,0 +1,69 @@
+require "coffeekup/version"
+require "coffeekup/errors"
+require "coffeekup/configuration"
+require 'open3'
+require 'tilt'
+require 'fileutils'
+
+module Coffeekup
+  extend Configuration
+
+  def self.register_engine
+    Rails.application.assets.register_engine ".#{self.extension}", Coffeekup::Template
+  end
+
+
+  # Takes coffeescript coffeekup file (.js.ck) and returns compiled js template.
+  # JS templates are loaded into window.#{self.namespace} object, ie:
+  #   /app/assets/javascripts/views/shared/index.js.ck => templates['shared.index']({})
+  #
+  # Templates are searched under self.base_directory (defaults /app/assets/javascripts/views) and
+  # must be a path that the asset pipeline recognizes in order to have sprockets load the files.
+  #
+  #  params:
+  #    source           input file path
+  #    options
+  #      namespace      optional js template namespace to use instead of default
+  #  
+  #  returns:
+  #    contents of compiled coffeekup js template
+  #
+  def self.compile!(source, options = {})
+    nspace = options[:namespace] || self.namespace
+    base_dir = self.base_directory
+    base_dir += "/" if base_dir[-1] != "/" 
+    filename = source.split(base_dir).last.gsub("/", ".").gsub('.js', '')
+    @files = {
+      :tmp => "#{Rails.root}/tmp/#{filename}",
+      :compiled_tmp => "#{Rails.root}/tmp/#{filename}".gsub(self.extension, 'js')
+    }
+    FileUtils.cp(source, @files[:tmp])
+    i, o, stderr = Open3.popen3("coffeekup --js --format --namespace '#{nspace}' '#{@files[:tmp]}'")
+    errors = stderr.read
+    raise CompilationError, "#{source}\n\n#{errors}" if not errors.blank?
+    
+    File.open(@files[:compiled_tmp]).read      
+  end
+
+  
+  def self.cleanup
+    @files.each{|f| File.delete(f[1]) rescue nil }
+  end
+  
+  class Template < Tilt::Template
+
+    def prepare    
+    end
+
+    def evaluate(context, locals, &block)
+      begin
+        compiled_output = Coffeekup.compile!(@file)
+      ensure
+        Coffeekup.cleanup
+      end
+
+      compiled_output
+    end
+  end
+end
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: coffeekup_rails
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Chris McCord
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-08 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: CoffeeKup Rails is an asset pipeline engine/preprocessor for CoffeeKup template files.
+email: 
+- chris@chrismccord.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- coffeekup.gemspec
+- lib/coffeekup/configuration.rb
+- lib/coffeekup/errors.rb
+- lib/coffeekup/version.rb
+- lib/coffeekup_rails.rb
+has_rdoc: true
+homepage: https://github.com/chrismccord/coffeekup_rails
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: coffeekup_rails
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Asset pipeline engine/preprocessor for CoffeeKup template files
+test_files: []
+