ruby-requirejs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58f4f4f4aba74d633bcdc94f249b0df14fef27a5
+  data.tar.gz: e90156c95ecbab9d56ccf7706aeeb108dc1bd687
+SHA512:
+  metadata.gz: b86323d78c0657d60b0df4382e102dff8375424d3db85ef167efe621a13b08fb527ff4103091655b1078e8d1740e59c696f3f5ec3fa1487db2db9835fe602939
+  data.tar.gz: 3e7b818d2c1caf66c1837ef2e183cc129fad30c73074a3fe545b650c5efbcc29fc7217f5adcc847756e99c4a7e49e818ea3e6e2b5fce46c4ae61b50886b2d749

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+Guardfile
+atlassian-ide-plugin.xml
+.rspec
+spec/database.yml
+.ruby-gemset
+.ruby-version
+log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ruby-requirejs.gemspec
+gemspec
+
+gem 'rspec',           '~> 2.14.0'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Alex Krasinsky
+
+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,85 @@
+# Ruby Requirejs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-requirejs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-requirejs
+
+
+## Configuration
+
+### With Rails and the Asset Pipeline.
+
+#### Development
+You have several options. For development default configuration should be enough for you.
+By default requirejs will not perform any optimization or compression.
+
+#### Production
+For production setup you would probably want to use [almond](https://github.com/jrburke/almond) as an alternative loader.
+To enable `almond` you need to configure your `config/environments/{environment}.rb` or `config/environment.rb` if you want to use `almond` all the time (I would not recommend it)
+
+    config.requirejs.loader = :almond
+
+`ruby-requirejs` currently supports js_compression only with `uglifier`. To enable:
+
+    config.requirejs.js_compressor = :uglifier
+
+If you don't want to use `almond` remove `config.requirejs.loader = :almond` and instead add `config.requirejs.optimize = true`
+
+### Standalone Sprockets usage
+
+#### TODO: Coming soon
+
+## Usage
+
+In your `application.js` add directive `rjs` so `ruby-requirejs` will know that this file should be processed as an entry point
+Example of `application.js` can look like this:
+
+    //= rjs
+
+    require.config({
+      shim:{
+        "jquery":{
+          exports:"$"
+        },
+        "turbolinks":{
+          exports:"Turbolinks"
+        },
+        "jquery_ujs":["jquery"],
+        "app":{
+          deps:[
+            "jquery",
+            "jquery_ujs",
+            "turbolinks"
+          ]
+        }
+      },
+
+        waitSeconds: 10,
+      catchError:false
+    });
+
+    require(["jquery", "turbolinks", "jquery_ujs", "app"], function ($, Turbolinks, uJS, App) {
+      App.initialize();
+    });
+
+During `r.js` optimization `ruby-requirejs` will automatically add fingerprints to assets if this is set in configuration.
+
+## Contributing
+
+Want to add some examples? Document code? Implement new feature? Fix bug?
+
+1. Fork it ( http://github.com/<my-github-username>/ruby-requirejs/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/requirejs/action_view/tag_helper.rb

@@ -0,0 +1,15 @@
+module Requirejs
+  module ActionView
+    module TagHelper
+      def requirejs_include_tag(*sources)
+        if Requirejs.config.almond?
+          javascript_include_tag(*sources)
+        else
+          sources.uniq.map do |source|
+            javascript_include_tag('require', data: { main: path_to_javascript(source).gsub!(/(^.*)\.js$/, '\1') })
+          end.join("\n").html_safe
+        end
+      end
+    end
+  end
+end

data/lib/requirejs/builds/build.js.erb

@@ -0,0 +1,8 @@
+//Load the requirejs optimizer
+var requirejs = require("<%= Requirejs.config.runtime_location %>");
+
+//Define optimize function so it can be called from within ExecJS
+var optimize = function () {
+    requirejs.optimize(<%= config.as_json %>);
+};
+

data/lib/requirejs/builds/build.rb

@@ -0,0 +1,18 @@
+module Requirejs
+  class Build
+    def initialize(scope, file, original_data)
+      @scope, @file = scope, file
+      @original_data = original_data
+    end
+
+    def data
+      <<-JS
+require.config({
+  paths: #{ Manifest.new(@scope, @file).paths_as_json }
+});
+#{@original_data}
+      JS
+    end
+
+  end
+end

data/lib/requirejs/builds/build_config.rb

@@ -0,0 +1,59 @@
+module Requirejs
+  # Class handles storing and retrieving build config for each rjs-manifest file
+  class BuildConfig
+
+    def initialize(file)
+      @file = file
+    end
+
+    def data
+      @data ||= begin
+        data = {
+            wrap: true,
+            baseUrl: Requirejs.config.cache_assets_location,
+            optimize: Requirejs.config.js_compressor,
+            out: File.join(Requirejs.config.cache_builds_location, basename)
+        }.merge(config_from_file)
+        data[:name] = 'almond' if Requirejs.config.almond?
+        data
+      end
+    end
+
+    def as_json
+      JSON.dump(data)
+    end
+
+    # Dumps hash with build config to yaml file
+    def save(hash)
+      File.open(file_path, 'w') do |f|
+        f.write(YAML.dump(hash))
+      end
+    end
+
+    def exists?
+      File.exists?(file_path)
+    end
+
+    private
+
+    def file_path
+      File.join(Requirejs.config.cache_build_scripts_location, "#{name}.yaml")
+    end
+
+    # Read config from file
+    def config_from_file
+      YAML.load(File.read(file_path))
+    end
+
+    # The basename of the template file.
+    def basename(suffix='')
+      File.basename(@file, suffix)
+    end
+
+    # The template file's basename with all extensions chomped off.
+    def name
+      basename.split('.', 2).first if basename
+    end
+
+  end
+end

data/lib/requirejs/builds/optimized_build.rb

@@ -0,0 +1,57 @@
+module Requirejs
+  class OptimizedBuild
+    def initialize(scope, file, original_data)
+      @scope, @file = scope, file
+      @original_data = original_data
+    end
+
+    def prepare
+      store_data_to_asset
+      copy_assets
+    end
+
+    def data
+      prepare
+      ::Requirejs::Runtime.new(build_script).exec
+      File.read(config.data[:out])
+    end
+
+    private
+
+    def build_script
+      build_script_path = File.join(Requirejs.config.gem_root_path, 'lib', 'requirejs', 'builds', 'build.js.erb')
+      ERB.new(File.read(build_script_path)).result(binding)
+    end
+
+    # Store data in assets cache dir so it will be used in compilation
+    def store_data_to_asset
+      File.open(File.join(Requirejs.config.cache_assets_location, File.basename(@file)), 'w') do |f|
+        f.write @original_data
+      end
+    end
+
+    # Store assets in assets cache dir so we can use them during compilation
+    def copy_assets
+      @scope.environment.each_logical_path do |logical_path|
+        copy_asset(logical_path) if copy_asset?(logical_path)
+      end
+    end
+
+    def copy_asset(logical_path)
+      @scope.environment.find_asset(logical_path).write_to(asset_path(logical_path))
+    end
+
+    def asset_path(logical_path)
+      File.join(Requirejs.config.cache_assets_location, logical_path).to_s
+    end
+
+    def copy_asset?(logical_path)
+      !File.exists?(asset_path(logical_path)) && (logical_path =~/.*\.js$/) && (File.basename(logical_path) != File.basename(@file))
+    end
+
+    def config
+      @config ||= ::Requirejs::BuildConfig.new(@file)
+    end
+
+  end
+end

data/lib/requirejs/compiler.rb

@@ -0,0 +1,21 @@
+module Requirejs
+  class Compiler
+    attr_accessor :scope, :data, :file, :build_script_path
+
+    def initialize(options ={})
+      Requirejs.config.ensure_cache_location_exists
+      @scope, @data, @file = options[:scope], options[:data], options[:file]
+    end
+
+    def exec
+      if Requirejs.config.optimize?
+        OptimizedBuild.new(@scope, @file, @data).data
+      elsif Requirejs.config.digest?
+        Build.new(@scope, @file, @data).data
+      else
+        @data
+      end
+    end
+
+  end
+end

data/lib/requirejs/config.rb

@@ -0,0 +1,72 @@
+module Requirejs
+  class Config < ::ActiveSupport::OrderedOptions
+    def initialize
+      super
+
+      self.gem_root_path = Gem::Specification.find_by_name('ruby-requirejs').gem_dir
+      self.runtime_location = File.join(gem_root_path, 'lib', 'requirejs', 'runtime', 'r.js')
+      self.cache_location = nil
+      self.js_compressor = :none # :uglify
+
+      self.loader = :requirejs # :almond
+      self.optimize = false # :almond
+      self.digest = false # :almond
+    end
+
+    def cache_assets_location
+      check_cache_location
+      @cache_assets_location ||= File.join(cache_location, 'assets')
+    end
+
+    def cache_build_scripts_location
+      check_cache_location
+      @cache_build_scripts_location ||= File.join(cache_location, 'build_scripts')
+    end
+
+    def cache_builds_location
+      check_cache_location
+      @cache_builds_location ||= File.join(cache_location, 'builds')
+    end
+
+    def check_cache_location
+      raise 'cache location is not set. Set cache_location. Ex.: Require.config.cache_location  = File.dirname(__FILE__)' if cache_location.blank?
+    end
+
+    def setup_directories
+      cleanup_cache_dir
+      ensure_cache_location_exists
+    end
+
+    def ensure_cache_location_exists
+      [cache_location, cache_assets_location, cache_build_scripts_location, cache_builds_location].each do |path|
+        Pathname.new(path).mkpath
+      end
+    end
+
+    def cleanup_cache_dir
+      FileUtils.remove_entry_secure(self.cache_location) rescue nil
+    end
+
+    def almond?
+      self.loader == :almond
+    end
+
+    def optimize?
+      almond? || self.optimize
+    end
+
+    def digest?
+      self.digest
+    end
+
+  end
+
+  # Config accessors
+  def self.config=(config)
+    @config = config
+  end
+
+  def self.config
+    @config
+  end
+end

data/lib/requirejs/engine.rb

@@ -0,0 +1,40 @@
+module Requirejs
+  class Engine < ::Rails::Engine
+
+    config.before_configuration do
+      config.requirejs = Requirejs.config = Requirejs::Config.new
+      Requirejs.config.cache_location = ::Rails.root.join('tmp', 'ruby-requirejs')
+    end
+
+    config.assets.configure do |env|
+      # Switching to rjs javascript compressor
+      if env.js_compressor && env.js_compressor.name == 'Sprockets::UglifierCompressor'
+        config.requirejs.js_compressor = :uglify
+      else
+        :none
+      end
+
+      # Disable default assets pipeline compression
+      env.js_compressor = nil
+
+      config.requirejs.digest = config.assets.digest
+
+      # Changing Processors
+      require 'requirejs/tilt/template'
+      require 'requirejs/tilt/directive_processor'
+      env.unregister_processor('application/javascript', Sprockets::DirectiveProcessor)
+      env.register_preprocessor('application/javascript', Requirejs::Tilt::DirectiveProcessor)
+
+      if Requirejs.config.optimize?
+        config.assets.precompile << 'require.js' unless Requirejs.config.almond?
+      else
+        # Ready to precompile everything
+        config.assets.precompile += env.paths.map { |path| Dir.glob(File.join(path, '**', '*.{js,coffee}')) }.flatten.uniq
+        config.assets.uniq!
+      end
+
+      env.register_bundle_processor('application/javascript', Requirejs::Tilt::Template)
+    end
+
+  end
+end