rjs-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b059627e7c4b6f1e515338d289b4ec37dff7b865
+  data.tar.gz: ed3121cd6a6ffb02c1f3329e714645d695df1909
+SHA512:
+  metadata.gz: 52f5e01eda1731d3118a3c2e14b4ec47c3790dc1281aca3ccf24afd5eff1199ed668a21a41b0d8def059fb803fcaa2e0da27fee98fad3da704f94b657a59bcf8
+  data.tar.gz: c2c39222397c61709591c9a81bc0764659b18ac122cf0902e0371d0404ee2e7bb80ec367d00a1ce00daaead9a7685fbd0259e12f57ade2131d03ceaf0e7b5001

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= RjsRails
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RjsRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/rjs-rails.rb

@@ -0,0 +1,8 @@
+require 'rjs-rails/env'
+require 'rjs-rails/build_env'
+require 'rjs-rails/runtime_env'
+require 'rjs-rails/rjs_helpers'
+
+module RjsRails
+end
+require 'rjs-rails/railtie' if defined?(Rails)

data/lib/rjs-rails/build.js.erb

@@ -0,0 +1,13 @@
+var baseConfig = <%= JSON.pretty_generate(build_env.config) %>
+baseConfig["onModuleBundleComplete"] = function(data) {
+  console.log("Module Finished:", data.path);
+  for (var i=0; i<data.included.length; i++) {
+  	console.log('  ' + data.included[i]);
+  }
+  console.log("total files:", data.included.length);
+};
+
+var requirejs = require("<%= config.rjs_path %>");
+
+requirejs.optimize(baseConfig);
+

data/lib/rjs-rails/build_env.rb

@@ -0,0 +1,68 @@
+module RjsRails
+  class BuildEnv
+
+    attr_accessor :env
+
+    def initialize(env)
+      @env = env
+      config
+    end
+
+    def base_config
+      return @base_config if @base_config
+      base_config = {
+        "baseUrl"             => env.source_dir,
+        "dir"                 => env.build_dir,
+        "optimize"            => "none",
+        "skipDirOptimize"     => true,
+        "keepBuildDir"        => false,
+        "normalizeDirDefines" => "skip"
+      } 
+    end  
+
+    def user_config
+      @user_config ||= load_yml_config
+    end
+
+    def config
+      @config ||= base_config.merge(user_config)
+    end  
+
+    def modules
+      config["modules"] || []
+    end  
+
+    def module_names
+      modules.collect { |m| m["name"] }
+    end
+
+    def yml_exists?
+      File.exists? yml
+    end  
+
+    def shims
+      config["shim"] || {}
+    end
+
+    def assets_for_precompile
+      js = []
+      js << 'require.js'
+      modules.each { |m| js << "#{m["name"]}.js" }
+      js
+    end  
+
+    private
+
+    def yml
+      env.rjs_build_yml
+    end  
+
+    def load_yml_config
+      return {} if not File.exists? yml
+      File.open(yml) { |f|
+        return YAML.load(f.read)
+      }  
+    end  
+
+  end  
+end  

data/lib/rjs-rails/env.rb

@@ -0,0 +1,46 @@
+module RjsRails
+  class Env
+    
+    def config
+      return @conf if @conf
+      c = ::ActiveSupport::OrderedOptions.new
+      c.extensions         = [/.js$/]
+      c.source_dir         = "#{Rails.root}/tmp/assets_source_dir"
+      c.build_dir   = "#{Rails.root}/tmp/assets_build_dir"
+      c.rjs_build_yml   = "#{Rails.root}/config/rjs_build.yml"
+      c.rjs_runtime_yml = "#{Rails.root}/config/rjs_runtime.yml"
+      c.rjs_path           = File.expand_path("../../vendor/assets/javascripts/r.js", File.dirname(__FILE__))
+      c.template           = File.expand_path("./build.js.erb", File.dirname(__FILE__))
+      c.build_js           = "#{Rails.root}/tmp/build.js"
+      @conf = c
+    end  
+
+    def build_env
+      @build_env ||= RjsRails::BuildEnv.new(config)
+    end
+
+    def runtime_env
+      @runtime_env ||= RjsRails::RuntimeEnv.new(config)
+    end  
+
+    def reload!
+      @build_env = nil
+      @runtime_env = nil
+      build_env
+      runtime_env
+    end
+
+    def get_binding()
+      binding()
+    end  
+
+    def precompile_required?
+      build_env.yml_exists?
+    end
+
+    def assets_for_precompile
+      build_env.assets_for_precompile
+    end  
+
+  end
+end  

data/lib/rjs-rails/railtie.rb

@@ -0,0 +1,17 @@
+module RjsRails
+  class Railtie < Rails::Railtie
+    initializer "rjs_rails.configure_rails_initialization" do
+      config.rjs = RjsRails::Env.new
+      ActionView::Base.send :include, RjsRails::RjsHelpers
+    end
+
+    config.to_prepare do
+      Rails.application.config.rjs.reload!
+    end
+
+    rake_tasks do
+      load File.expand_path("../tasks/rjs-rails.rake", File.dirname(__FILE__))
+    end
+
+  end
+end  

data/lib/rjs-rails/rjs_helpers.rb

@@ -0,0 +1,32 @@
+module RjsRails
+  module RjsHelpers
+
+    def rjs_include_tag(js)
+      tag = rjs_static_include + rjs_dynamic_template(js)
+      tag.html_safe
+    end
+
+    def rjs_static_include
+      rjs_runtime.rjs_static_include
+    end  
+
+    def rjs_dynamic_template(js)
+      "<script data-main=\"#{rjs_javascript_path(js)}\" src=\"#{javascript_path "require.js"}\"></script>"
+    end
+  
+    def rjs_javascript_path(js)
+      path = javascript_path(js).sub(/^#{rjs_baseurl}/,'')
+      path = path.sub(/.js$/,'')
+      path
+    end
+
+    def rjs_baseurl()
+      rjs_runtime.baseurl
+    end
+
+    def rjs_runtime
+      Rails.application.config.rjs.runtime_env
+    end  
+
+  end  
+end  

data/lib/rjs-rails/runtime_env.rb

@@ -0,0 +1,85 @@
+module RjsRails
+  class RuntimeEnv
+
+    attr_accessor :env
+
+    def initialize(env)
+      @env = env
+      rjs_static_include
+    end
+
+    def base_config
+      return @base_config if @base_config
+      base_config = {
+        "baseUrl"      => baseurl,
+        "paths"        => module_paths,
+        "shim"         => shims,
+        "waitSeconds"  => 0
+      } 
+    end  
+
+    def user_config
+      @user_config ||= load_yml_config
+    end
+
+    def config
+      @config ||= base_config.merge(user_config)
+    end
+
+    def rjs_static_include
+      @static_template ||= build_static_include
+    end  
+
+
+    def yml
+      env.rjs_runtime_yml
+    end  
+
+    def baseurl
+      "#{Rails.application.config.asset_host}#{Rails.application.config.assets.prefix}/"
+    end
+
+    def module_names
+      Rails.application.config.rjs.build_env.module_names
+    end
+
+    def shims
+      Rails.application.config.rjs.build_env.shims
+    end
+
+    def helpers
+      ActionController::Base.helpers
+    end  
+
+    def module_path(m)
+      helpers.javascript_path("#{m}.js").sub(/.js$/,"")
+    end  
+
+    def module_paths
+      paths = {}
+      module_names.each { |m| paths[m] = module_path(m) }
+      paths
+    end  
+
+    def static_template
+      erb_template = <<-EOF
+        <script>var require = <%= JSON.generate(config).html_safe %>;</script>
+      EOF
+    end
+
+    def build_static_include
+      erb = ERB.new(static_template)
+      p = Proc.new { config }
+      binding = Kernel.binding
+      erb.result(binding)
+    end  
+    
+    def load_yml_config
+      return {} if not File.exists? yml
+      File.open(yml) { |f|
+        return YAML.load(f.read)
+      }  
+    end  
+
+  end  
+end  

data/lib/rjs-rails/version.rb

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

data/lib/tasks/rjs-rails.rake

@@ -0,0 +1,123 @@
+namespace :rjs do
+ 
+  rjs = RjsRails::Env.new
+  config = rjs.config
+  source_dir = config.source_dir
+  build_dir = config.build_dir
+
+  def clean_dir(dir)
+    print "Cleaning #{dir} ..."
+    FileUtils.remove_entry_secure(dir, true)
+    FileUtils.mkpath dir
+    puts " done"
+  end
+
+  class NoCompression
+    def compress(string)
+      string
+    end
+  end
+
+   def disable_gc
+      GC.disable
+      begin
+        yield
+      ensure
+       # GC.enable
+       # GC.start
+      end
+   end
+
+  task "clean_dirs" do
+    clean_dir(source_dir)
+    clean_dir(build_dir)
+  end
+
+  task "build_init" => ["assets:cache:clean", "rjs:clean_dirs"]
+
+  desc "Copy project's all javascript files to #{source_dir}"
+  task "copy_js_sources" => [ "assets:environment", "rjs:clean_dirs" ] do
+    print "Copying js sources"
+    Rails.application.config.assets.js_compressor = NoCompression.new
+    assets = Rails.application.assets
+    js_assets = assets.each_logical_path(["*.js"])
+    num_assets = js_assets.count
+    count = 0
+    js_assets.each do |logical_path|
+      if asset = assets.find_asset(logical_path)
+        filename = "#{source_dir}/#{logical_path}"
+        asset.write_to(filename)
+      end  
+      count += 1
+      percent = count*100/num_assets
+      print "\rCopying js sources .. #{percent}% complete"
+    end 
+    puts
+  end
+
+  desc "Generate build.js for r.js"
+  task "prepare_build_js" do
+    puts "Generating build.js"
+    template = config.template
+    output_file = config.build_js
+    binding = rjs.get_binding()
+    File.open(template) { |f|
+      erb = ERB.new(f.read)
+      File.open(output_file , 'w') { |of|
+        of.write(erb.result(binding))
+      }
+    }
+  end
+
+  desc "Rjs asset build rake task"
+  task "optimization" do 
+    command = "node #{config.build_js}"
+    IO.popen(command) { |f|
+      f.each { |line|
+        puts line
+      }
+    }
+  end
+
+  task "build_end" => [ 
+    "refresh_sprockets_env",
+    "additional_assets_for_precompile",
+    "reenable_assets_cache_clean"
+  ]
+
+  desc "Add #{build_dir} to sprockets index "
+  task "refresh_sprockets_env" do
+    assets_env = Rails.application.assets.instance_variable_get("@environment")
+    assets_env.prepend_path(build_dir)
+    assets_env.js_compressor = Uglifier.new
+    Rails.application.assets = assets_env.index
+  end  
+ 
+  task "additional_assets_for_precompile" do
+    assets_array = rjs.assets_for_precompile
+    Rails.application.config.assets.precompile.concat(assets_array)
+  end  
+
+  task "reenable_assets_cache_clean" do
+    Rake::Task["assets:cache:clean"].reenable
+  end  
+
+
+  desc "Build r.js optimized js files to #{build_dir}"
+  task "build" => [
+    "rjs:build_init",
+    "rjs:copy_js_sources",
+    "rjs:prepare_build_js",
+    "rjs:optimization",
+    "rjs:build_end"
+  ]
+
+  desc "rjs assets precompile"
+  task "precompile" do
+    if rjs.precompile_required?
+      Rake::Task["rjs:build"].invoke
+    end
+  end
+
+end
+task "assets:precompile" => ["rjs:precompile"]