RubyGems - opal-sprockets - Versions diffs - 0.2.1 → 0.3.0 - Mend

opal-sprockets 0.2.1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (8) hide show

checksums.yaml +4 -4
data/README.md +97 -2
data/lib/opal/sprockets/erb.rb +2 -3
data/lib/opal/sprockets/processor.rb +32 -11
data/lib/opal/sprockets/server.rb +11 -5
data/lib/opal/sprockets/version.rb +1 -1
data/opal-sprockets.gemspec +1 -1
metadata +4 -4

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f599646138983764d471f03e02ca55d2d9d7b8ee
-  data.tar.gz: 3683e235bd9da2c28ae8e72256fa38f0a56c86fe
+  metadata.gz: a8b04180f54f9eacd9d9747b07f672fd7d0a3eec
+  data.tar.gz: d99d41d4c89bfee3986ad9c1a3a31116ae72c5f1
 SHA512:
-  metadata.gz: 668349a8e33e7db6615ad32b32d8061bd4c4136e0a4cc3858ac0c5a290300bb7782c99480107a80d6a4f2146f7f5040fb467899e5476383b61469af2db9502d1
-  data.tar.gz: 5a9cef7b65581cc8ff6a9ee3246bfe00f5445b6608ac0aaef936aa418c94d5c98b6e3b87de3833f00f5c4879d5734ec414bcc43a286023be7eae48d08187cde4
+  metadata.gz: d2a6c9e34bb10d7e70b68b9e4564821cbad9fec5add260261e5a26405b18b8c4d6e8e80008a3b7861db5b9edc6acbc6290bc443ec03b71a3136169d7b30bd796
+  data.tar.gz: a65a54c75521c62ac96e210dcdc1bed5d68c8e3e45c3bc62a38261364180113f3ca58059972b2ca0a64e18daba9b2a8517eac6ca89e97e77784f219616f9a764

data/README.md CHANGED Viewed

@@ -1,6 +1,101 @@
-# opal-sprockets
+# Opal Sprockets
-Adds sprockets support for Opal
+_Adds sprockets support for [Opal](http://opalrb.org)._
+## Installation
+Add to your `Gemfile`:
+```ruby
+gem "opal-sprockets"
+```
+## Usage
+Sprockets uses a set of load paths to resolve dependencies. This gem extends
+sprockets to provide opal load paths to sprockets. `opal-sprockets` provides
+a template processor for all files with `.rb` or `.opal` extensions.
+```ruby
+#= require opal
+puts "opal running in sprockets!"
+```
+### Improved require support
+By default, sprockets will examine your code for processor directive comments
+to handle requires, e.g. `#= require opal`. Opal takes this one step futher
+by extending the opal processor to automatically detect and register any
+`require` call made inside your ruby code:
+```ruby
+require "opal"
+require "opal-jquery"
+puts "opal-jquery is now available!"
+```
+Opal cannot require files at runtime, so this trick allows ruby code to use
+the nicer ruby syntax for requiring dependencies.
+## Example
+Sprockets uses a load path for code files, so make a simple `app/` directory
+with some code inside `app/application.rb`:
+```ruby
+# app/application.rb
+require "opal"
+puts "hello, world"
+```
+The opal corelib and runtime can be included in your app simply by adding
+`require "opal"`. We also need an html file to test the application with,
+so add `index.html`:
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <script src="/assets/application.js"></script>
+</head>
+<body>
+</body>
+</html>
+```
+### Running Application
+`opal-sprockets` comes with a simple `Server` class that can be used to easily
+configure applications inside `config.ru`:
+```ruby
+# config.ru
+require 'bundler'
+Bundler.require
+run Opal::Server.new { |s|
+  s.append_path 'app'
+  s.main = 'application'
+}
+```
+This just adds the `app/` directory to the load path, and tells sprockets that
+`application.rb` will be the main file to load.
+Now just run the rack app:
+```
+$ bundle exec rackup
+```
+And then visit `http://127.0.0.1:9292` in any browser.
 ## License

data/lib/opal/sprockets/erb.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 require 'opal'
-require 'opal/parser'
+require 'opal/compiler'
 require 'sprockets'
 module Opal
@@ -16,11 +16,10 @@ module Opal
       end
       def prepare
-        # ...
       end
       def evaluate(scope, locals, &block)
-        Opal::ERB.parse data, scope.logical_path.sub(/^templates\//, '')
+        Opal::ERB.compile data, scope.logical_path.sub(/^templates\//, '')
       end
     end
   end

data/lib/opal/sprockets/processor.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'set'
 require 'sprockets'
 $OPAL_SOURCE_MAPS = {}
@@ -33,7 +34,6 @@ module Opal
     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
@@ -42,13 +42,20 @@ module Opal
     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 self.stub_file(name)
+      stubbed_files << name.to_s
+    end
+    def self.stubbed_files
+      @stubbed_files ||= Set.new
+    end
     def initialize_engine
       require_template_library 'opal'
     end
@@ -59,32 +66,46 @@ module Opal
     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::RequireParser.new
-      result = parser.parse data, options
+      compiler = Opal::Compiler.new
+      result = compiler.compile data, options
-      parser.requires.each do |r|
+      compiler.requires.each do |r|
+        next if stubbed_file? r
         path = find_opal_require context.environment, r
         context.require_asset path
       end
-      if options[:source_map_enabled]
-        $OPAL_SOURCE_MAPS[context.pathname] = Opal::SourceMap.new(parser.fragments, "file://#{context.pathname.to_s}").to_s
-        "#{result}\n//@ sourceMappingURL=/__opal_source_maps__/#{context.logical_path}.js.map\n"
+      if self.class.source_map_enabled
+        $OPAL_SOURCE_MAPS[context.pathname] = compiler.source_map(source_file_url(context)).to_s
+        "#{result}\n//@ sourceMappingURL=#{source_map_url(context)}\n"
       else
         result
       end
     end
+    def source_map_url(context)
+      "#{prefix}/#{context.logical_path}.js.map"
+    end
+    def source_file_url(context)
+      "#{prefix}/#{context.logical_path.to_s}"
+    end
+    def prefix
+      "/__opal_source_maps__"
+    end
+    def stubbed_file?(name)
+      self.class.stubbed_files.include? name
+    end
     def find_opal_require(environment, r)
       path = environment.paths.find do |p|
         File.exist?(File.join(p, "#{r}.rb"))

data/lib/opal/sprockets/server.rb CHANGED Viewed

@@ -27,11 +27,17 @@ module Opal
     end
     def call(env)
-      path   = env['PATH_INFO'].gsub(/^\/|\.js\.map$/, '')
-      asset  = sprockets[path]
-      return [404, {}, []] if asset.nil?
+      path_info = env['PATH_INFO']
-      return [200, {"Content-Type" => "text/json"}, [$OPAL_SOURCE_MAPS[asset.pathname].to_s]]
+      if path_info =~ /\.js\.map$/
+        path   = env['PATH_INFO'].gsub(/^\/|\.js\.map$/, '')
+        asset  = sprockets[path]
+        return [404, {}, []] if asset.nil?
+        return [200, {"Content-Type" => "text/json"}, [$OPAL_SOURCE_MAPS[asset.pathname].to_s]]
+      else
+        return [200, {"Content-Type" => "text/text"}, [File.read(sprockets.resolve(path_info))]]
+      end
     end
   end
@@ -74,7 +80,7 @@ module Opal
       @app = Rack::Builder.app do
         use Rack::ShowExceptions
         map('/assets') { run sprockets }
-        map(server.source_maps.prefix) { run server.source_maps } if @source_map_enabled
+        map(server.source_maps.prefix) { run server.source_maps } if server.source_map_enabled
         use Index, server
         run Rack::Directory.new(server.public_dir)
       end

data/lib/opal/sprockets/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module Opal
   module Sprockets
-    VERSION = '0.2.1'
+    VERSION = '0.3.0'
   end
 end

data/opal-sprockets.gemspec CHANGED Viewed

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.require_paths  = ['lib']
   s.add_dependency 'sprockets'
-  s.add_dependency 'opal', '~> 0.4.4'
+  s.add_dependency 'opal', '~> 0.5.0'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opal-sprockets
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Adam Beynon
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-10-23 00:00:00.000000000 Z
+date: 2013-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.4
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement