yellow-brick-road 0.2.2 → 0.2.3

data/README.rst

@@ -11,6 +11,8 @@ Yellow-brick-road is a set of tools to integrate google `closure library <http:/
 
 * Automatic dependency generation of a closure library based application, just add the ``//= require_closure_root`` directive.
 
+* Compiling protocol buffer files to closure library ``goog.proto2.Message`` subclasses, as a rake task.
+
 * Using soy templates as part of the closure library.
 
 * Using stand-alone soy templates without closure library, just configure the gem add the ``.js.soy`` file in assets directory, and it gets compiled automatically.
@@ -23,13 +25,19 @@ Setup
 To use yellow-brick-road in rails, add these gems to ``Gemfile``:
 
 ::
+
+  # To enable protocol buffer support.
+  # Add this gem _before_ yellow-brick-road.
+  gem 'protobuf-closure-library'
   
   gem 'yellow-brick-road'
+
+  # To use internal closure library.
   gem 'closure-library-wrapper',
     :git => 'git://github.com/alitn/closure-library-wrapper.git',
     :submodules => true
     
-When an external closure library source is used, the second gem is not necessary.
+When an external closure library source is used, ``closure-library-wrapper`` gem is not necessary.
 
 Configuration
 +++++++++++++

data/Rakefile

@@ -20,8 +20,6 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
@@ -33,5 +31,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task :default => :test

data/lib/generators/templates/yellow_brick_road.rb.erb

@@ -12,8 +12,20 @@ YellowBrickRoad.setup do |config|
   # When this options is used, the above commit-id lock will be ignored.
   # config.closure_library_root = '/path/to/your/closure-library-root'
 
+  # Set a namespace or an array of namespaces of your closure
+  # app to be passed to closurebuilder.py, see: 
+  # http://code.google.com/closure/library/docs/closurebuilder.html
+  # This a required options when Rails.application.config.assets.debug
+  # is set to false.
+  # config.closure_namespace = 'your.closure.namespace'
+
   # Uncomment this to use yellow-brick-road as an standalone
   # soy template compiler. If this option is used, the output
   # of the compiler will be different -- see the documentation.
   # config.standalone_soy = true
+
+  # Uncomment this to not clear asset cache on application start.
+  # It is recommended to set this option to true to avoid confolicts
+  # in closure applications raise by stale cache.
+  # config.clear_asset_cache_on_startup = false
 end

data/lib/tasks/ybr.rake

@@ -0,0 +1,12 @@
+namespace :ybr do
+
+  if YellowBrickRoad.protobuf_enabled
+    desc 'Compile protocol buffer files.'
+    task :compile_protos do
+      initializer = Rails.root.join 'config', 'initializers', 'yellow_brick_road.rb'
+      require initializer
+      YellowBrickRoad.compile_protos Logger.new(STDOUT)
+    end
+  end
+
+end

data/lib/yellow-brick-road.rb

@@ -1,6 +1,11 @@
 require 'yellow-brick-road/version'
 require 'yellow-brick-road/config'
 require 'yellow-brick-road/utils'
+begin
+  require 'protobuf-closure-library'
+  require 'yellow-brick-road/protobuf_js'
+rescue LoadError
+end
 require 'yellow-brick-road/directive_processor'
 require 'yellow-brick-road/soy_processor'
 require 'yellow-brick-road/engine'

data/lib/yellow-brick-road/config.rb

@@ -7,8 +7,12 @@ module YellowBrickRoad
   VENDOR_ROOT = File.join ROOT, 'vendor'
 
   CLOSURE_LIBRARY_ROOT_INTERNAL = ClosureLibraryWrapper.closure_library_root
-  CLOSURE_LIBRARY_BASE_RELPATH = ['closure', 'goog', 'base.js']
+  CLOSURE_LIBRARY_GOOG_RELPATH = ['closure', 'goog']
+  CLOSURE_LIBRARY_THIRD_PARTY_RELPATH = ['third_party', 'closure', 'goog']
+  CLOSURE_LIBRARY_BASE_FILE_NAME = 'base.js'
+  CLOSURE_LIBRARY_DEPS_FILE_NAME = 'deps.js'
   CLOSURE_DEPSWRITER_RELPATH = ['closure', 'bin', 'build', 'depswriter.py']
+  CLOSURE_BUILDER_RELPATH = ['closure', 'bin', 'build', 'closurebuilder.py']
 
   CLOSURE_SOYUTILS_ROOT = File.join VENDOR_ROOT, 'closure-soyutils'
   CLOSURE_SOYUTILS_USEGOOG_ROOT = File.join VENDOR_ROOT, 'closure-soyutils-usegoog'
@@ -19,17 +23,48 @@ module YellowBrickRoad
 
   # Config.
 
-  mattr_accessor :closure_library_root
-  @@closure_library_root = CLOSURE_LIBRARY_ROOT_INTERNAL
-
   mattr_reader :closure_deps_writer
+  mattr_reader :closure_builder
+
+  mattr_reader :closure_library_goog
+  mattr_reader :closure_library_third_party
   mattr_reader :closure_library_base
+  mattr_reader :closure_library_deps
 
+  mattr_accessor :closure_library_root
+  @@closure_library_root = CLOSURE_LIBRARY_ROOT_INTERNAL
   def self.closure_library_root= value
     @@closure_library_root = value
     self.update_closure_library_properties
   end
 
+  mattr_accessor :closure_namespace
+  @@closure_namespace = ''
+
+  mattr_accessor :concat_closure_roots
+  def self.initClosureConfig
+    @@concat_closure_roots = !Rails.application.config.assets.debug
+  end
+
+  mattr_accessor :clear_asset_cache_on_startup
+  @@clear_asset_cache_on_startup = true
+
+  mattr_reader :protobuf_enabled
+  @@protobuf_enabled = false
+
+  mattr_accessor :protos_dir
+  mattr_accessor :protos_js_out_dir
+  def self.initProtos
+    @@protos_dir ||= Rails.root.join 'app', 'protos', '**', '*.proto'
+    @@protos_js_out_dir ||= Rails.root.join 'app', 'assets', 'javascripts', 'protos'
+  end
+
+  mattr_accessor :protobuf_js_superclass
+  @@protobuf_js_superclass = nil
+
+  mattr_accessor :protobuf_js_advanced
+  @@protobuf_js_advanced = false
+
   mattr_accessor :standalone_soy
   @@stand_alone_soy = false
 
@@ -41,11 +76,15 @@ module YellowBrickRoad
     yield self
   end
 
-  private
+private
 
   def self.update_closure_library_properties
     @@closure_deps_writer = File.join @@closure_library_root, *CLOSURE_DEPSWRITER_RELPATH
-    @@closure_library_base = File.join @@closure_library_root, *CLOSURE_LIBRARY_BASE_RELPATH
+    @@closure_builder = File.join @@closure_library_root, *CLOSURE_BUILDER_RELPATH
+    @@closure_library_goog = File.join @@closure_library_root, *CLOSURE_LIBRARY_GOOG_RELPATH
+    @@closure_library_third_party = File.join @@closure_library_root, *CLOSURE_LIBRARY_THIRD_PARTY_RELPATH
+    @@closure_library_base = File.join @@closure_library_goog, CLOSURE_LIBRARY_BASE_FILE_NAME
+    @@closure_library_deps = File.join @@closure_library_goog, CLOSURE_LIBRARY_DEPS_FILE_NAME
   end
   self.update_closure_library_properties
 

data/lib/yellow-brick-road/directive_processor.rb

@@ -3,16 +3,21 @@ require 'sprockets/directive_processor.rb'
 module YellowBrickRoad
 class ClosureBuilderProcessor < Sprockets::DirectiveProcessor
 
+  GOOG_BASE_REL_PATH = File.join '..', '..'
+
   def prepare
     super
     @closure_roots = []
     @closure_deps_file = Rails.root.join *CLOSURE_DEPS_FILE_RELPATH
     @closure_root_prefix = File.join '..', '..'
-    @has_executed_closure_builder = false
+    @has_processed_closure_roots = false
   end
 
   def process_require_closure_root_directive path
-    context.require_asset YellowBrickRoad.closure_library_base
+    if !YellowBrickRoad.concat_closure_roots
+      context.require_asset YellowBrickRoad.closure_library_base
+      context.require_asset YellowBrickRoad.closure_library_deps
+    end
     context.require_asset @closure_deps_file
 
     if relative? path
@@ -41,36 +46,110 @@ class ClosureBuilderProcessor < Sprockets::DirectiveProcessor
 
   def process_directives
     super
-    generate_closure_dependencies
+    process_closure_roots
   end
 
 private
   
-  def generate_closure_dependencies
-    return nil if @closure_roots.empty? || @has_executed_closure_builder
+  def process_closure_roots
+    return nil if @closure_roots.empty? || @has_processed_closure_roots
 
     if !YellowBrickRoad.standalone_soy
-      @closure_roots.unshift << {
+      @closure_roots.unshift ({
         path: CLOSURE_SOYUTILS_USEGOOG_ROOT,
-        path_relative_to_goog_base: '/'
-      }
+        path_relative_to_goog_base: GOOG_BASE_REL_PATH
+      })
+    end
+
+    if YellowBrickRoad.protobuf_enabled
+      context.depend_on YellowBrickRoad.protos_js_out_dir
+      @closure_roots.unshift ({
+        path: YellowBrickRoad.protos_js_out_dir,
+        path_relative_to_goog_base: File.join('..', '..')
+      })
     end
 
+    result = YellowBrickRoad.concat_closure_roots ?
+      generate_concat : generate_no_concat
+
+    @has_processed_closure_roots = true
+
+    result
+  end
+
+  def generate_no_concat
+    # Gather roots.
     closure_roots_with_prefix = @closure_roots.map { |cr| "'#{cr[:path]} #{cr[:path_relative_to_goog_base]}'" }
 
+    # Run depswriter.
     result = Utils::run_command YellowBrickRoad.closure_deps_writer,
       command_options: {
         root_with_prefix: closure_roots_with_prefix,
         output_file: @closure_deps_file
       },
       command_error_message: 'An error occured while running closure depswriter.py.'
+    
+    # Clean up and report.
+    closure_roots = @closure_roots.map { |cr| cr[:path] }
+    Rails.logger.info "Executed closure depswriter.py on root paths: #{closure_roots.join(', ')}"
+
+    result
+  end
 
-    @has_executed_closure_builder = true
-    Rails.logger.info "Executed closure depswriter.py on root paths: #{@closure_roots.join(', ')}"
+  def generate_concat
+    # Check for namespace.
+    namespace = YellowBrickRoad.closure_namespace
+    if namespace.empty?
+      raise <<-FIN
+        No closure namespace was given. One or more input files to
+        calculate dependencies is required by closurebuilder.py. Set
+        a namespace or an array of namespaces to YellowBrickRoad.closure_namespace
+        in the initializer.
+      FIN
+    end
 
+    # Gather roots.
+    closure_roots = @closure_roots.map { |cr| cr[:path] }
+    closure_roots.unshift YellowBrickRoad.closure_library_third_party
+    closure_roots.unshift YellowBrickRoad.closure_library_goog
+
+    # Generate soy files.
+    soy_files = []
+    Rails.application.assets.each_file do |asset_file|
+      soy_files << asset_file.to_s if asset_file.extname == '.soy'
+    end
+    soy_out_dir = Dir.mktmpdir
+    compile_soy_templates soy_files, soy_out_dir
+    closure_roots << soy_out_dir
+
+    # Run closurebuilder.
+    result = Utils::run_command YellowBrickRoad.closure_builder,
+      command_options: {
+        root: closure_roots,
+        output_mode: 'script',
+        namespace: namespace,
+        output_file: @closure_deps_file
+      },
+      command_error_message: 'An error occured while running closurebuilder.py.'
+
+    # Clean up and report.
+    FileUtils.remove_entry_secure soy_out_dir
+    Rails.logger.info "Executed closurebuilder.py on root paths: #{closure_roots.join(', ')}"
 
     result
   end
 
+  def compile_soy_templates soy_files, out_dir
+    return if soy_files.empty?
+
+    result = Utils::run_command "java -jar #{CLOSURE_SOY_COMPILER}",
+      command_arg: soy_files.join(' '),
+      command_options: {
+        outputPathFormat: File.join(out_dir, '{INPUT_DIRECTORY}/{INPUT_FILE_NAME_NO_EXT}_{LOCALE_LOWER_CASE}.js'),
+        shouldProvideRequireSoyNamespaces: '',
+      },
+      command_error_message: 'An error occured while running closurebuilder.py.'
+  end
+
 end
 end

data/lib/yellow-brick-road/engine.rb

@@ -3,6 +3,11 @@ module YellowBrickRoad
 class Engine < Rails::Engine
 
   initializer :yellow_brick_road do |app|
+    if YellowBrickRoad.clear_asset_cache_on_startup
+      Rails.application.assets.cache.clear
+    end
+
+    YellowBrickRoad.initClosureConfig
     app.assets.append_path YellowBrickRoad.closure_library_root
 
     if YellowBrickRoad.standalone_soy
@@ -11,6 +16,11 @@ class Engine < Rails::Engine
       app.assets.append_path CLOSURE_SOYUTILS_USEGOOG_ROOT
     end
 
+    if YellowBrickRoad.protobuf_enabled
+      YellowBrickRoad.initProtos
+      app.assets.append_path YellowBrickRoad.protos_js_out_dir
+    end
+
     app.assets.unregister_processor 'application/javascript', Sprockets::DirectiveProcessor
     app.assets.register_processor 'application/javascript', ClosureBuilderProcessor
 

data/lib/yellow-brick-road/protobuf_js.rb

@@ -0,0 +1,32 @@
+
+module YellowBrickRoad
+  @@protobuf_enabled = true
+  include ProtobufClosureLibrary
+
+  def self.compile_protos logger = Rails.logger
+    YellowBrickRoad.initProtos
+    proto_files = Dir[YellowBrickRoad.protos_dir]
+
+    if proto_files.empty?
+      logger.info "No protobuf file to compile in #{YellowBrickRoad.protos_dir}."
+      return
+    end
+
+    generator_options = {}
+    if YellowBrickRoad.protobuf_js_superclass
+      generator_options[:js_superclass] = YellowBrickRoad.protobuf_js_superclass
+    end
+    if YellowBrickRoad.protobuf_js_advanced
+      generator_options[:advanced] = 'true'
+    end
+
+    logger.info 'Compiling protobuf to closure-library javascript:'
+    proto_files.each do |proto_file|
+      logger.info "\t- #{proto_file}"
+      ProtocJs.compile proto_file, YellowBrickRoad.protos_js_out_dir,
+        generator_options: generator_options
+    end
+    logger.info "Compiled all to #{YellowBrickRoad.protos_js_out_dir}"
+  end
+
+end

data/lib/yellow-brick-road/soy_processor.rb

@@ -1,4 +1,5 @@
 require 'tilt'
+require 'tempfile'
 
 module YellowBrickRoad
 class SoyProcessor < Tilt::Template
@@ -27,15 +28,23 @@ class SoyProcessor < Tilt::Template
   attr_reader :namespace
 
   def evaluate scope, locals, &block
+    # When concatenating closure code by closurebuilder,
+    # the soy processor should not function as it will lead to
+    # duplicated code.
+    # Completely unregistering the soy processor is not an option
+    # as we need to track the soy files assets.
+    return ';' if YellowBrickRoad.concat_closure_roots
+
     # Since SoyToJsSrcCompiler does not provide a stdout access to
     # the output, the output is written to a tempfile.
-    tempoutput = Rails.root.join 'tmp', "soy-#{Time.now.to_i.to_s}.js"
-    compiler_options= @compiler_options.merge outputPathFormat: tempoutput
+    # tempoutput = Rails.root.join 'tmp', "soy-#{Time.now.to_i.to_s}.js"
+    tempfile = Tempfile.new 'soy'
+    compiler_options = @compiler_options.merge outputPathFormat: tempfile.path
 
     compile compiler_options
 
-    @output = IO.read tempoutput
-    File.delete tempoutput
+    @output = IO.read tempfile.path
+    tempfile.unlink
 
     @output
   end

data/lib/yellow-brick-road/utils.rb

@@ -21,7 +21,13 @@ class Utils
       raise "#{options[:command_error_message]}\n\n#{error.message}"
     end
 
-    stdout.readlines
+    err = stderr.readlines
+    if false# !err.empty?
+      err = err.join('')
+      # Wrap longs texts.
+      err.gsub!(/(.{1,#{120}})( +|$\n?)|(.{1,#{120}})/, "\\1\\3\n")
+      raise "#{options[:command_error_message]}\n\n#{err}"
+    end
   end
 
   private

data/lib/yellow-brick-road/version.rb

@@ -1,3 +1,3 @@
 module YellowBrickRoad
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

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

@@ -7,6 +7,7 @@
 //= require jquery
 //= require jquery_ujs
 //= require_closure_root ./my-closure
+//= require_closure_root ./protos
 //= require ./my-closure/simple.js.soy
 //= require ./my-closure/start
 //

data/test/dummy/app/assets/javascripts/closure-deps.js

@@ -1,4 +1,5 @@
 // This file was autogenerated by /Users/ali/.rvm/gems/ruby-1.9.3-p0/bundler/gems/closure-library-wrapper-031d1d0f0e50/vendor/closure-library/closure/bin/build/depswriter.py.
 // Please do not edit.
 goog.addDependency('../../my-closure/start.js', ['myproject.start'], ['goog.dom', 'myproject.templates']);
-goog.addDependency('/soyutils_usegoog.js', ['soy', 'soy.StringBuilder', 'soy.esc', 'soydata', 'soydata.SanitizedHtml', 'soydata.SanitizedHtmlAttribute', 'soydata.SanitizedJsStrChars', 'soydata.SanitizedUri'], ['goog.asserts', 'goog.dom.DomHelper', 'goog.format', 'goog.i18n.BidiFormatter', 'goog.i18n.bidi', 'goog.soy', 'goog.string', 'goog.string.StringBuffer']);
+goog.addDependency('../../protos/person.pb.js', ['Person'], ['goog.proto2.Message']);
+goog.addDependency('/../../../soyutils_usegoog.js', ['soy', 'soy.StringBuilder', 'soy.esc', 'soydata', 'soydata.SanitizedHtml', 'soydata.SanitizedHtmlAttribute', 'soydata.SanitizedJsStrChars', 'soydata.SanitizedUri'], ['goog.asserts', 'goog.dom.DomHelper', 'goog.format', 'goog.i18n.BidiFormatter', 'goog.i18n.bidi', 'goog.soy', 'goog.string', 'goog.string.StringBuffer']);