coffeekupper 0.0.2

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Zohar Arad
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# CoffeeKupper
+
+CoffeeKupper is a CoffeeKup template parser for Rails Asset-Pipeline. With CoffeeKupper you can write CoffeeKup templates
+in your Rails app, and serve them via your asset pipeline.
+
+CoffeeKupper is just a wrapper around CoffeeKup that breaks your template file into a string that is then fed into the `CoffeeKup.compile` method.
+This means you can use your CoffeeKupper templates as you would use any CoffeeKup template.
+
+You should check out the [CoffeeKup Website](http://coffeekup.org) for more details on how to use CoffeeKup.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'coffeekupper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install coffeekupper
+
+## Usage
+
+### Basic Concepts
+
+The best way to use CoffeeKup templates (powered by CoffeeKupper), is to write them as JST files. In case you're not familiar with
+Sprockets' JST, by adding a `.jst` extention to your Javascript files, Sprockets will serve them in a special way, that will make each
+file available under the global JST object. Think of it as a global way to access encapsulated templates.
+
+To serve a CoffeeKup template from Rails, lets assume you have a `views` directory under `app/assets/javascripts`. Add a
+CoffeeKup template file to that directory and give it a name (for example, name your file `my_first_view.jst.ck`). Note the
+addition of `.jst` before the `.ck` file extension. This will tell Sprockets to add the template to the global JST object.
+
+Now, add a bit of CoffeeKup code. Maybe something along the lines of:
+```coffeescript
+h1 -> 'Hello CoffeKupper'
+p ->
+  'I would love to hear some more from you'
+```
+
+If you point your browser to `http://localhost:3000/assets/views/my_first_view.js` you'll see the JST version of your template.
+
+Sweet, right?
+
+### Adding to the asset pipeline
+
+To actually use the template in your app, add the following lines to your `application.js` (or any other Javascript file that has been added to the Asset Pipeline):
+
+```
+//browser version of CoffeeScript (available from CoffeeKupper vendor/assets)
+//= require coffee-script
+//browser version of CoffeeKup (available from CoffeeKupper vendor/assets)
+//= require coffeekup
+//= require_tree ./views
+```
+
+When you actually want to render your template from another Javascript file, simply call:
+
+```javascript
+var html = JST['views/my_first_view']()
+```
+
+### Passing template variables
+
+Passing variables to your template is easy. Just add them as an object to the template call.
+
+Assumming we have the following CoffeeKup template:
+
+```coffeescript
+header ->
+  h1 -> @title
+  h2 -> @subtitle
+p ->
+  @text
+```
+
+We can pass the right variables to the template like this:
+
+```javascript
+var html = JST['views/my_first_view']({title:"Some title", subtitle:"Some subtitle", text:"Some text"})
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Copyright (c) 2012 Zohar Arad <zohar@zohararad.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/coffeekupper.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/coffeekupper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Zohar Arad"]
+  gem.email         = ["zohar@zohararad.com"]
+  gem.description   = %q{CoffeeKup compiler for Asset Pipeline}
+  gem.summary       = %q{Write client side templates in Rails using CoffeeKup}
+  gem.homepage      = "https://github.com/zohararad/coffeekupper"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "coffeekupper"
+  gem.require_paths = ["lib"]
+  gem.version       = Coffeekupper::VERSION
+
+  gem.add_dependency             'sprockets', '>= 2.1.3'
+  gem.add_development_dependency 'therubyracer'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rails', '>= 3.1.1'
+end

data/lib/coffeekupper.rb

@@ -0,0 +1,5 @@
+require "coffeekupper/template"
+require "coffeekupper/engine" if defined?(::Rails)
+
+module Coffeekupper
+end

data/lib/coffeekupper/engine.rb

@@ -0,0 +1,17 @@
+module Coffeekupper
+
+  class Engine < Rails::Engine
+
+    initializer "coffeekupper.configure_rails_initialization", :before => 'sprockets.environment', :group => :all do |app|
+      next unless app.config.assets.enabled
+
+      require 'sprockets'
+      require 'sprockets/engines'
+      require 'coffeekupper/template'
+      Sprockets.register_engine '.coffeekup', ::Coffeekupper::Template
+      Sprockets.register_engine '.ck', ::Coffeekupper::Template
+    end
+
+  end
+
+end

data/lib/coffeekupper/template.rb

@@ -0,0 +1,28 @@
+require 'tilt/template'
+
+module Coffeekupper
+
+  class Template < Tilt::Template
+
+    self.default_mime_type = 'application/javascript'
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      %( (function(){ var tmpl = #{template_as_string(data)}; return CoffeeKup.compile(tmpl) })() )
+    end
+
+    private
+
+    # Splits a CoffeeKup template into lines joined by "+" sign
+    # so the template text can be properly fed into the CoffeeKup compiler as a
+    # concatenation of Javascript strings
+    # @param [String] template the template to split
+    # @return [String] split template as concatenation of Javascript strings
+    def template_as_string(template)
+      template.split("\n").collect{|line| '"' + line.gsub(/\"/,'\\"') + '"' }.join('+'+'"\n"'+'+')
+    end
+
+  end
+end

data/lib/coffeekupper/version.rb

@@ -0,0 +1,3 @@
+module Coffeekupper
+  VERSION = "0.0.2"
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/spec/dummy/app/assets/javascripts/sample.js.coffeekup

@@ -0,0 +1,6 @@
+h1 ->
+  'Hello World'
+p ->
+  'Some Text For Hello'
+for i in [1,2,3,4,5]
+  p -> "#{i}"

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,65 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "active_resource/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require
+require "coffeekupper"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = true
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end