barista 0.5.1 → 0.6.0

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--debug

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use  "ree-1.8.7-2010.02@barista"

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem 'jeweler'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    barista (0.5.1)
+      open4
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    gemcutter (0.6.1)
+    git (1.2.5)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    open4 (1.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  barista!
+  jeweler
+  open4

data/README.md

@@ -1,5 +1,9 @@
 # Barista #
 
+Barista is a rails plugin that transparently compiles CoffeeScript to JavaScript. When a `.coffee` file is changed and the page is refreshed, it delays sending the `.js` file until it's been regenerated from the newly modified CoffeeScript. This way, you can refresh immediately after saving the `.coffee` file, and not worry about an old `.js` file being sent to the browser (as often happens when using `coffee --watch`).
+
+Barista supports using `therubyracer` when installed or, by default, the node.js version of CoffeeScript via the `coffee` executable.
+
 Barista is very, very similar to [bistro\_car](http://github.com/jnicklas/bistro_car) (infact, credit where credit is due - it shares similar
 code / is almost a fork).
 
@@ -27,9 +31,9 @@ Barista require rails 3+ (but patches for Rails 2 will be accepted.)
 
 ## Frameworks ##
 
-One of the other main features Barista adds (over bistro\_car) is frameworks similar
-to Compass. The idea being, you add coffeescripts at runtime from gems etc. To do this,
-in your gem just have a coffeescript directory and then in you gem add the following code:
+One of the other main features Barista adds (over other tools) is frameworks similar
+to Compass. The idea being, you add coffee scripts at runtime from gems etc. To do this,
+in your gem just have a `coffeescript` directory and then in you gem add the following code:
 
     Barista::Framework.register 'name', 'full-path-to-directory' if defined?(Barista::Framework)
     
@@ -83,16 +87,38 @@ on compilation.
 Please note that barista lets you configure several options. To do this,
 it's as simple as setting up an initializer with:
 
-    rails generate barista_install
+    rails generate barista:install
     
 Then editing `config/initializers/barista_config.rb`.
 
 Currently available options are:
 
-* root - the folder path to read coffeescripts from, defaults to app/coffeescripts
-* output\_root - the folder to write them into, defautls to public/javascripts.
-* no\_wrap - stop coffee from automatically wrapping JS in a closure.
-* change\_output\_prefix! - method to change the output prefix for a framework.
+* `root` - the folder path to read coffeescripts from, defaults to app/coffeescripts
+* `output_root` - the folder to write them into, defaults to public/javascripts.
+* `no_wrap` and `bare` - stop coffee from automatically wrapping JS in a closure.
+* `change_output_prefix!` - method to change the output prefix for a framework.
+* All of the hooks mentioned above.
+* `verbose` - whether or not barista will add a preamble to files.
+* `compiler` - One of `:native` or `:node`, to force the compiler version.
+* `compiler_klass` - A custom compiler class.
+* `js_path` - Path to the pure-javascript compiler 
+
+# Contributors / Credits
+
+The following people have all contributed to Barista:
+
+* [Xavier Shay](https://github.com/xaviershay) - Added preamble text to generated text in verbose mode.
+* [einarmagnus](https://github.com/einarmagnus) - Fixed jruby support.
+* [Matt Dean](https://github.com/trabian) - Added `before_full_compilation` and `on_compilation_complete` hooks.
+* [Trevor Burnham](https://github.com/TrevorBurnham) - Misc. documentation tweaks and hooks idea.
+* [Sean McCullough](https://github.com/mcculloughsean) - Initial switch to support bare (vs. no\_wrap)
+* [Ben Atkin](https://github.com/benatkin) - Docs work.
+
+Barista was originally heavily inspired by [Bistro Car](https://github.com/jnicklas/bistro_car), but taking a fundamentally
+different approach in a few areas.
+
+The Native JavaScript compiler was heavily inspired by and based on [Sam Stephenson's](https://github.com/sstephenson) fork of
+the ruby-coffee-script gem. All credit for the idea goes to him and the code is based on his simple approach.
 
 ## Note on Patches/Pull Requests ##
  
@@ -104,4 +130,4 @@ Currently available options are:
 
 ## Copyright ##
 
-Copyright (c) 2010 Darcy Laycock. See LICENSE for details.
+Copyright (c) 2010 Darcy Laycock. See LICENSE for details.

data/Rakefile

@@ -14,6 +14,12 @@ begin
     gem.version     = Barista::Version::STRING
     gem.authors     = ["Darcy Laycock"]
     gem.add_dependency 'open4'
+    gem.add_dependency 'railties', '~> 3.0'
+    
+    gem.add_development_dependency 'rspec', '~> 2.0.0.beta.22'
+    gem.add_development_dependency 'rr', '~> 1.0'
+    gem.add_development_dependency 'therubyracer'
+    
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/barista.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{barista}
-  s.version = "0.5.1"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Darcy Laycock"]
-  s.date = %q{2010-09-19}
+  s.date = %q{2010-11-15}
   s.description = %q{Automatically compiles app/coffeescripts/*.coffee to javascript for rails awesomesauce.}
   s.email = %q{sutto@sutto.net}
   s.extra_rdoc_files = [
@@ -19,6 +19,10 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     ".rspec",
+     ".rvmrc",
+     "Gemfile",
+     "Gemfile.lock",
      "LICENSE",
      "README.md",
      "Rakefile",
@@ -27,20 +31,32 @@ Gem::Specification.new do |s|
      "config/routes.rb",
      "lib/barista.rb",
      "lib/barista/compiler.rb",
+     "lib/barista/compilers.rb",
+     "lib/barista/compilers/base.rb",
+     "lib/barista/compilers/native.rb",
+     "lib/barista/compilers/node.rb",
      "lib/barista/filter.rb",
      "lib/barista/framework.rb",
      "lib/barista/hooks.rb",
      "lib/barista/tasks/barista.rake",
      "lib/barista/version.rb",
-     "lib/generators/barista_install/USAGE",
-     "lib/generators/barista_install/barista_install_generator.rb",
-     "lib/generators/barista_install/templates/initializer.rb"
+     "lib/coffee-script/coffee-script-0.9.4.js",
+     "lib/generators/barista/install/USAGE",
+     "lib/generators/barista/install/install_generator.rb",
+     "lib/generators/barista/install/templates/initializer.rb",
+     "lib/generators/barista_install_generator.rb",
+     "spec/barista_spec.rb",
+     "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/Sutto/barista}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Transparent coffeescript support for rails 3.}
+  s.test_files = [
+    "spec/barista_spec.rb",
+     "spec/spec_helper.rb"
+  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
@@ -48,11 +64,23 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<open4>, [">= 0"])
+      s.add_runtime_dependency(%q<railties>, ["~> 3.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_development_dependency(%q<rr>, ["~> 1.0"])
+      s.add_development_dependency(%q<therubyracer>, [">= 0"])
     else
       s.add_dependency(%q<open4>, [">= 0"])
+      s.add_dependency(%q<railties>, ["~> 3.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+      s.add_dependency(%q<rr>, ["~> 1.0"])
+      s.add_dependency(%q<therubyracer>, [">= 0"])
     end
   else
     s.add_dependency(%q<open4>, [">= 0"])
+    s.add_dependency(%q<railties>, ["~> 3.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.0.0.beta.22"])
+    s.add_dependency(%q<rr>, ["~> 1.0"])
+    s.add_dependency(%q<therubyracer>, [">= 0"])
   end
 end
 

data/lib/barista.rb

@@ -8,6 +8,7 @@ module Barista
   CompilerUnavailableError = Class.new(Error)
 
   autoload :Compiler,  'barista/compiler'
+  autoload :Compilers, 'barista/compilers'
   autoload :Filter,    'barista/filter'
   autoload :Framework, 'barista/framework'
   autoload :Hooks,     'barista/hooks'
@@ -135,22 +136,38 @@ module Barista
       Rails.logger.debug "[Barista] #{message}" if defined?(Rails.logger) && Rails.logger
     end
 
-    # By default, only add it in dev / test
-    def add_filter?
-      Rails.env.test? || Rails.env.development?
+    def verbose?
+      @verbose ||= (defined?(Rails) && (Rails.env.test? || Rails.env.development?))
     end
+    
+    def verbose!
+      self.verbose = true
+    end
+    
+    def verbose=(value)
+      @verbose = !!value
+    end
+
+    alias add_filter? verbose?
+    alias add_preamble? verbose?
 
     def no_wrap?
       defined?(@no_wrap) && @no_wrap
     end
+    alias bare? no_wrap?
 
     def no_wrap!
       self.no_wrap = true
     end
+    alias bare! no_wrap!
 
     def no_wrap=(value)
       @no_wrap = !!value
     end
+    alias bare= no_wrap= 
+
+    delegate :bin_path, :bin_path=, :js_path, :js_path=, :compiler, :compiler=,
+             :compiler_klass, :compiler_klass=, :to => Compiler
 
   end
 

data/lib/barista/compiler.rb

@@ -1,86 +1,51 @@
 require 'digest/sha2'
-require 'open4'
 
 module Barista
   class Compiler
 
-    class << self; attr_accessor :bin_path; end
-    self.bin_path ||= "coffee"
-
-    def self.available?
-      @coffee_available ||= system("which '#{self.bin_path}' >/dev/null 2>&1")
-    end
-
-    def self.check_availability!(silence = false)
-      available?.tap do |available|
-        if !available && Barista.exception_on_error? && !silence
-          raise CompilerUnavailableError, "The coffeescript compiler '#{self.bin_path}' could not be found."
-        end
-      end
+    class << self
+      attr_accessor :bin_path, :js_path
     end
+    self.bin_path ||= "coffee"
+    self.js_path  ||= File.expand_path('../coffee-script/coffee-script-0.9.4.js', File.dirname(__FILE__))
 
-    def self.compile(path, options = {})
-      new(path, options).to_js
+    def self.compilers
+      [Compilers::Native, Compilers::Node]
     end
-
-    def initialize(path, options = {})
-      @compiled = false
-      @options  = {}
-      @path     = path
+    
+    def self.compiler=(value)
+      name = "Barista::Compilers::#{value.to_s.classify}".constantize
+      self.compiler_klass = name
+    rescue
+      self.compiler_klass = nil
     end
-
-    def compile!
-      # Compiler code thanks to bistro_car.
-      @compiled_content = invoke_coffee(@path)
-      @compiled = true
+    
+    def self.compiler
+      compiler_klass.name.underscore.gsub("barista/compilers/", '').to_sym
     end
-
-    def to_js
-      compile! unless @compiled
-      @compiled_content
+    
+    def self.compiler_klass
+      @compiler_klass ||= compilers.detect(&:available?)
     end
-
-    def self.dirty?(from, to)
-      File.exist?(from) && (!File.exist?(to) || File.mtime(to) < File.mtime(from))
+    
+    def self.compiler_klass=(value)
+      @compiler_klass = value.present? ? value : nil
     end
 
-    protected
-
-    def coffee_options
-      ["-p"].tap do |options|
-        options << "--no-wrap" if Barista.no_wrap?
-      end.join(" ")
+    def self.available?
+      compiler_klass.present?
     end
 
-    def invoke_coffee(path)
-      command = "#{self.class.bin_path} #{coffee_options} '#{path}'".squeeze(' ')
-      Barista.invoke_hook :before_compilation, path
- 
-      #jruby cannot use open4 because it uses fork. 
-      #This should hopefully work for both jruby and ruby
-      popen_class = IO.respond_to?(:popen4) ? IO : Open4
- 
-      pid, stdin, stdout, stderr = popen_class.popen4(command)
-      stdin.close
-      _, status = Process.waitpid2(pid)
-      out = stdout.read.strip
-      err = stderr.read.strip
-      if status.success?
-        if err.blank?
-          Barista.invoke_hook :compiled, path
-        else
-          Barista.invoke_hook :compiled_with_warning, path, err
-        end
-      else
-        Barista.invoke_hook :compilation_failed, path, err
-        if Barista.exception_on_error? && !@options[:silence]
-          raise CompilationError, "\"#{command}\" exited with a non-zero status."
-        else
-          out = nil
+    def self.check_availability!(silence = false)
+      available?.tap do |available|
+        if !available && Barista.exception_on_error? && !silence
+          raise CompilerUnavailableError, "A coffee script compiler is currently unavailable. Please install therubyracer or coffee-script via node"
         end
       end
-      out
     end
 
+    def self.compile(path, options = {})
+      compiler_klass.new(path, options).to_js
+    end
   end
 end

data/lib/barista/compilers.rb

@@ -0,0 +1,9 @@
+module Barista
+  module Compilers
+    
+    autoload :Base,   'barista/compilers/base'
+    autoload :Native, 'barista/compilers/native'
+    autoload :Node,   'barista/compilers/node'
+    
+  end
+end

data/lib/barista/compilers/base.rb

@@ -0,0 +1,39 @@
+module Barista
+  module Compilers
+    class Base
+      
+      def self.available?
+        false
+      end
+      
+      def initialize(path, options = {})
+        @compiled = false
+        @options  = {}
+        @path     = path
+      end
+
+      def compile!
+        @compiled_content = invoke_coffee(@path)
+        @compiled_content = preamble + @compiled_content if Barista.add_preamble?
+        @compiled         = true
+      end
+
+      def to_js
+        compile! unless @compiled
+        @compiled_content
+      end
+
+      def self.dirty?(from, to)
+        File.exist?(from) && (!File.exist?(to) || File.mtime(to) < File.mtime(from))
+      end
+
+      protected
+
+      def preamble
+        "/* DO NOT MODIFY. This file was compiled from\n *   #{@path}\n */\n\n"
+      end
+      
+      
+    end
+  end
+end

data/lib/barista/compilers/native.rb

@@ -0,0 +1,55 @@
+# Most of the code in here is from sstephenson's fantastic
+# fork of the ruby-coffee-script gem (since merged in to master).
+#
+# All credit hence belongs with him - I simply ported it to
+# work with Barista.
+module Barista
+  module Compilers
+    class Native < Base
+      
+      def self.available?
+        @native_compiler_available ||= begin
+          require 'v8'
+          true
+        rescue LoadError
+          false
+        end
+      end
+      
+      def self.coffee_script_source
+        File.read(Compiler.js_path)
+      end
+      
+      def self.no_wrap_option
+        @no_wrap_option ||= coffee_script_source.include?('noWrap') ? 'noWrap' : 'bare'
+      end
+      
+      def self.coffee_script
+        @coffee_script ||= V8::Context.new.tap do |c|
+          c.eval(coffee_script_source)
+        end["CoffeeScript"]
+      end
+      
+      protected
+      
+      def coffee_script
+        self.class.coffee_script
+      end
+      
+      def invoke_coffee(path)
+        script = File.read(path)
+        Barista.invoke_hook :before_compilation, path
+        out = coffee_script.compile(script, self.class.no_wrap_option => Barista.no_wrap?)
+        Barista.invoke_hook :compiled, path
+        out
+      rescue V8::JSError => e
+        Barista.invoke_hook :compilation_failed, path, e.message
+        if Barista.exception_on_error? && !@options[:silence]
+          raise CompilationError, "CoffeeScript via V8 raised an exception"
+        end
+        nil
+      end
+      
+    end
+  end
+end