opal-sprockets 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,28 @@
+# opal-sprocets
+
+Adds sprockets support for Opal
+
+## License
+
+(The MIT License)
+
+Copyright (C) 2013 by Adam Beynon
+
+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/lib/opal/sprockets/environment.rb

@@ -0,0 +1,23 @@
+require 'sprockets'
+
+module Opal
+
+  # Environment is a subclass of Sprockets::Environment which already has our opal
+  # load paths loaded. This makes it easy for stand-alone rack apps, or test runners
+  # that have opal load paths ready to use. You can also add an existing gem's lib
+  # directory to our load path to use real gems inside your opal environment.
+  #
+  # If you are running rails, then you just need opal-rails instead, which will
+  # do this for you.
+  class Environment < ::Sprockets::Environment
+    def initialize *args
+      super
+      Opal.paths.each { |p| append_path p }
+    end
+
+    def use_gem gem_name
+      append_path File.join(Gem::Specification.find_by_name(gem_name).gem_dir, 'lib')
+    end
+  end
+end
+

data/lib/opal/sprockets/parser.rb

@@ -0,0 +1,84 @@
+require 'opal/parser'
+
+module Opal
+
+  # A subclass of Opal::Parser used exclusively by opal-sprockets to handle
+  # require statements automatically. We basically intercept any top level
+  # require statement, remove it from the code generation, and then pass it
+  # off to our sprockets context to handle it. This lets us use the ruby
+  # require syntax instead of having to use sprockets style comments.
+  class SprocketsParser < Parser
+
+    def self.parse source, options = {}
+      self.new.parse source, options
+    end
+
+    # Holds an array of paths which this file 'requires'.
+    # @return Array<String>
+    attr_reader :requires
+
+    def parse source, options = {}
+      @requires = []
+      @dynamic_require_severity = (options[:dynamic_require_severity] || :error)
+      super source, options
+    end
+
+    def process_call sexp, level
+      if sexp[1] == :require
+        return handle_require sexp[2][1]
+      end
+
+      super sexp, level
+    end
+
+    def handle_require(sexp)
+      str = handle_require_sexp sexp
+      @requires << str unless str.nil? if @requires
+      fragment("", sexp)
+    end
+
+    def handle_require_sexp(sexp)
+      type = sexp.shift
+
+      if type == :str
+        return sexp[0]
+      elsif type == :call
+        recv, meth, args = sexp
+        parts = args[1..-1].map { |s| handle_require_sexp s }
+
+        if recv == [:const, :File]
+          if meth == :expand_path
+            return handle_expand_path(*parts)
+          elsif meth == :join
+            return handle_expand_path parts.join("/")
+          elsif meth == :dirname
+            return handle_expand_path parts[0].split("/")[0...-1].join("/")
+          end
+        end
+      end
+
+
+      case @dynamic_require_severity
+      when :error
+        error "Cannot handle dynamic require"
+      when :warning
+        warning "Cannot handle dynamic require"
+      end
+    end
+
+    def handle_expand_path(path, base = '')
+      "#{base}/#{path}".split("/").inject([]) do |p, part|
+        if part == ''
+          # we had '//', so ignore
+        elsif part == '..'
+          p.pop
+        else
+          p << part
+        end
+
+        p
+      end.join "/"
+    end
+  end
+end
+

data/lib/opal/sprockets/processor.rb

@@ -0,0 +1,85 @@
+require 'sprockets'
+require 'opal/sprockets/parser'
+
+module Opal
+
+  # Proccess using Sprockets
+  #
+  #   Opal.process('opal-jquery')   # => String
+  def self.process asset
+    Environment.new[asset].to_s
+  end
+
+  # The Processor class is used to make ruby files (with rb or opal extensions)
+  # available to any sprockets based server. Processor will then get passed any
+  # ruby source file to build. There are some options you can override globally
+  # which effect how certain ruby features are handled:
+  #
+  #   * method_missing_enabled      [true by default]
+  #   * optimized_operators_enabled [true by default]
+  #   * arity_check_enabled         [false by default]
+  #   * const_missing_enabled       [true by default]
+  #   * dynamic_require_severity    [true by default]
+  #   * source_map_enabled          [true by default]
+  #   * irb_enabled                 [false by default]
+  #
+  class Processor < Tilt::Template
+    self.default_mime_type = 'application/javascript'
+
+    def self.engine_initialized?
+      true
+    end
+
+    class << self
+      attr_accessor :method_missing_enabled
+      attr_accessor :optimized_operators_enabled
+      attr_accessor :arity_check_enabled
+      attr_accessor :const_missing_enabled
+      attr_accessor :dynamic_require_severity
+      attr_accessor :source_map_enabled
+      attr_accessor :irb_enabled
+    end
+
+    self.method_missing_enabled      = true
+    self.optimized_operators_enabled = true
+    self.arity_check_enabled         = false
+    self.const_missing_enabled       = true
+    self.dynamic_require_severity    = :error # :error, :warning or :ignore
+    self.source_map_enabled          = true
+    self.irb_enabled                 = false
+
+    def initialize_engine
+      require_template_library 'opal'
+    end
+
+    def prepare
+    end
+
+    def evaluate(context, locals, &block)
+      options = {
+        :method_missing           => self.class.method_missing_enabled,
+        :optimized_operators      => self.class.optimized_operators_enabled,
+        :arity_check              => self.class.arity_check_enabled,
+        :const_missing            => self.class.const_missing_enabled,
+        :dynamic_require_severity => self.class.dynamic_require_severity,
+        :source_map_enabled       => self.class.source_map_enabled,
+        :irb                      => self.class.irb_enabled,
+        :file                     => context.logical_path,
+        :source_file              => context.pathname.to_s,
+      }
+
+      parser = Opal::SprocketsParser.new
+      result = parser.parse data, options
+
+      parser.requires.each { |r| context.require_asset r }
+      result
+    end
+  end
+end
+
+Tilt.register 'rb',               Opal::Processor
+Sprockets.register_engine '.rb',  Opal::Processor
+
+Tilt.register 'opal',               Opal::Processor
+Sprockets.register_engine '.opal',  Opal::Processor
+

data/lib/opal/sprockets/server.rb

@@ -0,0 +1,141 @@
+require 'rack/showexceptions'
+require 'opal/source_map'
+require 'opal/sprockets/source_map_header'
+require 'opal/sprockets/environment'
+require 'erb'
+
+module Opal
+
+  class SourceMapServer
+    def initialize sprockets
+      @sprockets = sprockets
+    end
+
+    attr_reader :sprockets
+
+    attr_writer :prefix
+
+    def prefix
+      @prefix ||= '/__opal_source_maps__'
+    end
+
+    def inspect
+      "#<#{self.class}:#{object_id}>"
+    end
+
+    def call(env)
+      path   = env['PATH_INFO'].gsub(/^\/|\.js\.map$/, '')
+      asset  = sprockets[path]
+      return [404, {}, []] if asset.nil?
+
+      source = asset.to_s
+      map    = Opal::SourceMap.new(source, asset.pathname.to_s)
+
+      return [200, {"Content-Type" => "text/json"}, [map.to_s]]
+    end
+  end
+
+  class Server
+
+    attr_accessor :debug, :index_path, :main, :public_dir, :sprockets
+
+    def initialize debug = true
+      @public_dir = '.'
+      @sprockets  = Environment.new
+      @debug      = debug
+
+      yield self if block_given?
+      create_app
+    end
+
+    def append_path path
+      @sprockets.append_path path
+    end
+
+    def use_gem gem_name
+      @sprockets.use_gem gem_name
+    end
+
+    def create_app
+      server, sprockets = self, @sprockets
+
+      @app = Rack::Builder.app do
+        use Rack::ShowExceptions
+        map('/assets') { run sprockets }
+        map(server.source_maps.prefix) { run server.source_maps }
+        use Index, server
+        run Rack::Directory.new(server.public_dir)
+      end
+    end
+
+    def source_maps
+      @source_maps ||= SourceMapServer.new(@sprockets)
+    end
+
+    def call(env)
+      @app.call env
+    end
+
+    class Index
+
+      def initialize(app, server)
+        @app = app
+        @server = server
+        @index_path = server.index_path
+      end
+
+      def call(env)
+        if %w[/ /index.html].include? env['PATH_INFO']
+          [200, { 'Content-Type' => 'text/html' }, [html]]
+        else
+          @app.call env
+        end
+      end
+
+      # Returns the html content for the root path. Supports ERB
+      def html
+        source = if @index_path
+          raise "index does not exist: #{@index_path}" unless File.exist?(@index_path)
+          File.read @index_path
+        elsif File.exist? 'index.html'
+          File.read 'index.html'
+        elsif File.exist? 'index.html.erb'
+          File.read 'index.html.erb'
+        else
+          SOURCE
+        end
+
+        ::ERB.new(source).result binding
+      end
+
+      def javascript_include_tag source
+        if @server.debug
+          assets = @server.sprockets[source].to_a
+
+          raise "Cannot find asset: #{source}" if assets.empty?
+
+          scripts = assets.map do |a|
+            %Q{<script src="/assets/#{ a.logical_path }?body=1"></script>}
+          end
+
+          scripts.join "\n"
+        else
+          "<script src=\"/assets/#{source}.js\"></script>"
+        end
+      end
+
+      SOURCE = <<-HTML
+  <!DOCTYPE html>
+  <html>
+  <head>
+    <title>Opal Server</title>
+  </head>
+  <body>
+    <%= javascript_include_tag @server.main %>
+  </body>
+  </html>
+      HTML
+    end
+  end
+end
+

data/lib/opal/sprockets/source_map_header.rb

@@ -0,0 +1,22 @@
+require 'sprockets/server'
+
+module Sprockets
+  module Server
+
+    # Adds the source map header to all sprocket responses for assets
+    # with a .rb or .opal extension in the extension chain.
+    def headers_with_opal_source_maps(env, asset, length)
+      headers_without_opal_source_maps(env, asset, length).tap do |headers|
+        if asset.pathname.to_s =~ /\.(rb|opal)\b/
+          headers['X-SourceMap'] = '/__opal_source_maps__/'+asset.logical_path + '.map'
+        end
+      end
+    end
+
+    # Poor man's alias_method_chain :)
+    alias headers_without_opal_source_maps headers
+    alias headers headers_with_opal_source_maps
+
+  end
+end
+

data/lib/opal/sprockets/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module Sprockets
+    VERSION = '0.1.0'
+  end
+end

data/lib/opal/sprockets.rb

@@ -0,0 +1,4 @@
+require 'opal/sprockets/environment'
+require 'opal/sprockets/parser'
+require 'opal/sprockets/processor'
+require 'opal/sprockets/server'

data/lib/opal-sprockets.rb

@@ -0,0 +1 @@
+require 'opal/sprockets'

data/opal-sprockets.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/opal/sprockets/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'opal-sprockets'
+  s.version      = Opal::Sprockets::VERSION
+  s.author       = 'Adam Beynon'
+  s.email        = 'adam.beynon@gmail.com'
+  s.homepage     = 'http://opalrb.org'
+  s.summary      = 'Sprockets support for opal'
+  s.description  = 'Sprockets suppoer for opal.'
+
+  s.files          = `git ls-files`.split("\n")
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+
+  s.add_dependency 'sprockets'
+  s.add_dependency 'opal', '~> 0.4.0'
+
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: opal-sprockets
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Beynon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sprockets suppoer for opal.
+email: adam.beynon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- lib/opal-sprockets.rb
+- lib/opal/sprockets.rb
+- lib/opal/sprockets/environment.rb
+- lib/opal/sprockets/parser.rb
+- lib/opal/sprockets/processor.rb
+- lib/opal/sprockets/server.rb
+- lib/opal/sprockets/source_map_header.rb
+- lib/opal/sprockets/version.rb
+- opal-sprockets.gemspec
+homepage: http://opalrb.org
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Sprockets support for opal
+test_files: []