barista 0.3.0 → 0.4.0

data/Rakefile

@@ -7,7 +7,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name        = "barista"
-    gem.summary     = %Q{Transparent coffeescript support for rails 3}
+    gem.summary     = %Q{Transparent coffeescript support for rails 3.}
     gem.description = %Q{Automatically compiles app/scripts/*.coffee to javascript for rails awesomesauce.}
     gem.email       = "sutto@sutto.net"
     gem.homepage    = "http://github.com/Sutto/barista"

data/barista.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{barista}
-  s.version = "0.3.0"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Darcy Laycock"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2010-07-06}
   s.description = %q{Automatically compiles app/scripts/*.coffee to javascript for rails awesomesauce.}
   s.email = %q{sutto@sutto.net}
   s.extra_rdoc_files = [
@@ -39,7 +39,7 @@ Gem::Specification.new do |s|
   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.summary = %q{Transparent coffeescript support for rails 3.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/lib/barista.rb

@@ -3,6 +3,10 @@ require 'pathname'
 
 module Barista
 
+  Error                    = Class.new(StandardError)
+  CompilationError         = Class.new(Error)
+  CompilerUnavailableError = Class.new(Error)
+
   autoload :Compiler,  'barista/compiler'
   autoload :Filter,    'barista/filter'
   autoload :Framework, 'barista/framework'
@@ -13,6 +17,15 @@ module Barista
       yield self if block_given?
     end
 
+    def exception_on_error?
+      @exception_on_error = true if !defined?(@exception_on_error)
+      !!@exception_on_error
+    end
+
+    def exception_on_error=(value)
+      @exception_on_error = value
+    end
+
     def root
       @root ||= Rails.root.join("app", "coffeescripts")
     end
@@ -30,78 +43,90 @@ module Barista
       @output_root = Pathname(value.to_s)
     end
 
-    def compile_file!(file, force = false)
+    def compile_file!(file, force = false, silence_error = false)
+      # Ensure we have a coffeescript compiler available.
+      if !Compiler.check_availability!(silence_error)
+        debug "The coffeescript compiler at '#{Compiler.bin_path}' is currently unavailable."
+        return ""
+      end
+      # Expand the path from the framework.
       origin_path, framework = Framework.full_path_for(file)
       return if origin_path.blank?
       destination_path = self.output_path_for(file)
       return unless force || Compiler.dirty?(origin_path, destination_path)
       debug "Compiling #{file} from framework '#{framework.name}'"
       FileUtils.mkdir_p File.dirname(destination_path)
-      content = Compiler.compile(origin_path)
+      content = Compiler.compile(origin_path, :silence_error => silence_error)
       # Write the rendered content to file.
-      File.open(destination_path, "w+") { |f| f.write content }
-      content
+      # nil is only when silence_error is true.
+      if content.nil?
+        debug "An error occured compiling '#{file}' - Leaving file as is."
+      else
+        File.open(destination_path, "w+") { |f| f.write content }
+        content
+      end
     rescue SystemCallError
+      debug "An unknown error occured attempting to compile '#{file}'"
       ""
     end
-    
-    def compile_all!(force = false)
+
+    def compile_all!(force = false, silence_error = true)
       debug "Compiling all coffeescripts"
       Framework.exposed_coffeescripts.each do |coffeescript|
-        compile_file! coffeescript, force
+        compile_file! coffeescript, force, silence_error
       end
       true
     end
-    
+
     def change_output_prefix!(framework, prefix = nil)
       framework = framework.is_a?(Barista::Framework) ? framework : Barista::Framework[framework]
       return unless framework
       framework.output_prefix = prefix
     end
-    
+
     def each_framework(include_default = false)
       Framework.all(include_default).each { yield if block_given? }
     end
-    
+
     def output_path_for(file)
       output_root.join(file.to_s.gsub(/^\/+/, '')).to_s.gsub(/\.coffee$/, '.js')
     end
-    
+
     def debug(message)
       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?
     end
-    
+
     def no_wrap?
       defined?(@no_wrap) && @no_wrap
     end
-    
+
     def no_wrap!
       self.no_wrap = true
     end
-    
+
     def no_wrap=(value)
       @no_wrap = !!value
     end
-    
+
   end
-  
+
   if defined?(Rails::Engine)
     class Engine < Rails::Engine
-      
+
       rake_tasks do
         load File.expand_path('./barista/tasks/barista.rake', File.dirname(__FILE__))
       end
-      
+
       initializer "barista.wrap_filter" do
         ActionController::Base.before_filter(Barista::Filter) if Barista.add_filter?
       end
-      
+
     end
   end
-  
+
 end

data/lib/barista/compiler.rb

@@ -2,50 +2,71 @@ require 'digest/sha2'
 
 module Barista
   class Compiler
-    
+
     class << self; attr_accessor :bin_path; end
     self.bin_path ||= "coffee"
-    
-    def self.compile(path)
-      new(path).to_js
+
+    def self.available?
+      @coffee_available ||= system("command -v '#{self.bin_path}' >/dev/null 2>&1")
+    end
+
+    def self.check_availability!(silence = false)
+      available?.tap do |available|
+        if Barista.exception_on_error? && !silence
+          raise CompilerUnavailableError, "The coffeescript compiler '#{self.bin_path}' could not be found."
+        end
+      end
     end
-    
-    def initialize(path)
+
+    def self.compile(path, options = {})
+      new(path, options).to_js
+    end
+
+    def initialize(path, options = {})
       @compiled = false
+      @options  = {}
       @path     = path
     end
-    
+
     def compile!
       # Compiler code thanks to bistro_car.
       @compiled_content = invoke_coffee(@path)
       @compiled = true
     end
-    
+
     def to_js
       compile! unless @compiled
-      @compiled_content.to_s
+      @compiled_content
     end
-    
+
     def self.dirty?(from, to)
       File.exist?(from) && (!File.exist?(to) || File.mtime(to) < File.mtime(from))
     end
-    
+
     protected
-    
+
     def coffee_options
       ["-p"].tap do |options|
         options << "--no-wrap" if Barista.no_wrap?
       end.join(" ")
     end
-    
+
     def invoke_coffee(path)
       command = "#{self.class.bin_path} #{coffee_options} '#{path}'".squeeze(' ')
-      %x(#{command})
+      result = %x(#{command}).to_s
+      if !$?.success?
+        if Barista.exception_on_error? && !@options[:silence]
+          raise CompilationError, "\"#{command}\" exited with a non-zero status."
+        else
+          result = nil
+        end
+      end
+      result
     end
-    
+
     def content_hash
       @content_hash ||= Digest::SHA256.hexdigest(@content)
     end
-    
+
   end
 end

data/lib/barista/filter.rb

@@ -1,10 +1,10 @@
 module Barista
   class Filter
-    
+
     def self.filter(controller)
       Rails.logger.debug "[Barista] Compiling all scripts"
       Barista.compile_all!
     end
-  
+
   end
-end
+end

data/lib/barista/framework.rb

@@ -1,26 +1,26 @@
 module Barista
   class Framework
-    
+
     def self.default_framework
       @default_framework ||= self.new("default", Barista.root)
     end
-    
+
     def self.default_framework=(value)
       @default_framework = value
     end
-    
+
     def self.all(include_default = false)
       all = (@all ||= [])
       all = [default_framework] + all if include_default
       all
     end
-    
+
     def self.exposed_coffeescripts
       all(true).inject([]) do |collection, fw|
         collection + fw.exposed_coffeescripts
       end.uniq.sort_by { |f| f.length }
     end
-    
+
     def self.full_path_for(script)
       script = script.to_s.gsub(/\.js$/, '.coffee').gsub(/^\/+/, '')
       all(true).each do |fw|
@@ -29,52 +29,52 @@ module Barista
       end
       nil
     end
-    
+
     def self.register(name, root)
       (@all ||= []) << self.new(name, root)
     end
-    
+
     def self.[](name)
       name = name.to_s
       (@all ||= []).detect { |fw| fw.name == name }
     end
-    
+
     attr_reader :name, :framework_root, :output_prefix
-    
+
     def initialize(name, root, output_prefix = nil)
       @name           = name.to_s
       @output_prefix  = nil
       @framework_root = File.expand_path(root)
     end
-    
+
     def coffeescripts
       Dir[File.join(@framework_root, "**", "*.coffee")]
     end
-    
+
     def short_name(script)
       short_name = remove_prefix script, @framework_root
       File.join *[@output_prefix, short_name].compact
     end
-    
+
     def exposed_coffeescripts
       coffeescripts.map { |script| short_name(script) }
     end
-    
+
     def output_prefix=(value)
       value = value.to_s.gsub /(^\/|\/$)/, ''
       @output_prefix = value.blank? ? nil : value
     end
-    
+
     def full_path_for(name)
       full_path = File.join(@framework_root, remove_prefix(name, @output_prefix.to_s))
       File.exist?(full_path) ? full_path : nil
     end
-    
+
     protected
-    
+
     def remove_prefix(path, prefix)
       path.to_s.gsub /^#{Regexp.escape(prefix.to_s)}\/?/, ''
     end
-    
+
   end
-end
+end

data/lib/barista/tasks/barista.rake

@@ -1,8 +1,12 @@
 namespace :barista do
-  
+
   desc "Compiles coffeescripts from app/scripts into public/javascripts"
   task :brew => :environment do
-    Barista.compile_all!(true)
+    if !Barista::Compiler.available?
+      $stderr.puts "'#{Barista::Compiler.bin_path}' was unavailable."
+      exit 1
+    end
+    Barista.compile_all! true, false
   end
-  
-end
+
+end

data/lib/barista/version.rb

@@ -1,7 +1,7 @@
 module Barista
   module Version
     MAJOR  = 0
-    MINOR  = 3
+    MINOR  = 4
     PATCH  = 0
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: barista
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Darcy Laycock
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 +08:00
+date: 2010-07-06 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -79,6 +79,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Transparent coffeescript support for rails 3
+summary: Transparent coffeescript support for rails 3.
 test_files: []