dart-rails 0.3.3 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ba3b1fec8b574b5d856481449754df86f78731a
-  data.tar.gz: 53041e94888bc2e5f276b9525a965f157b05af1f
+  metadata.gz: b9e7906077bee091c56e149dd43defb9a2b6dbf8
+  data.tar.gz: 51e20f466227ef6fa34cc349be2497af7174cf9a
 SHA512:
-  metadata.gz: ee0612b33ae83a5a743f9d4af706df4a0a52c0aeeb827bc778633f7699c0bde0400978c6fd95b325e9b1111d2c44ba5234412bbaed616be94c34ea4668cbf9a6
-  data.tar.gz: 2bfba33ecc72f6967bb7d67a82163305ec580fe7e82573e0c5c2649a5cb44b9b08f8a36dc175936e906539c3c3470826970b8f80c212f96daee8a10ab89db9f9
+  metadata.gz: 7b9f1a4ccfc4c8098c2ba2b5633d2372a11d9f406b4251edbc62a27db0af983c6c0663fa1cfec884a008acd9b15a95dd697b0d2adb86dfc20ccc025eebbd426b
+  data.tar.gz: 18d9dd1d896e25af465bb011ffd175be3cefe072f1574822c233ae5dd9dc49bf816c2267a84b28586df08c656ca7468e8b48063673fc38e1b17919430e658a50

data/README.md

@@ -2,50 +2,90 @@
 
 ### Idea ###
 
-Handle [dart](https://www.dartlang.org/ 'dartlang.org') scripts so they get transcoded to js for browsers
+Handle [dart](https://www.dartlang.org/ 'dartlang.org') scripts so they get compiled to js for browsers
 without dart support. Currently there's only the `Dartium` browser from the development-kit that supports
-dart directly.
-
-For now this is a rather stupid attempt, although it works.
+dart natively.
 
 For a working sample check [m0gg/dart-rails-sample](https://github.com/m0gg/dart-rails-sample 'm0gg/dart-rails-sample').
 
+## Attention ##
+If you're upgrading from versions prior `0.4.2` and use `sprockets >= 3.0.0` you need to replace your
+`dart_app.js.dart2js` or `dart_app.js` (depends form which version you're upgrading) with a symlink pointing to
+your `dart_app.dart` as `sprockets >= 3.0.0` no longer supports the `//= include` directive.
+
+example `ls app/assets/dart/`
+```bash
+$ ls app/assets/dart/dart_app.*
+app/assets/dart/dart_app.dart  app/assets/dart/dart_app.js.dart2js
+```
+
+
+
 ### Setup ###
 
-  1. `Gemfile`
+1. `Gemfile`
 
-    ```ruby
-    gem 'ruby-dart2js'
-    gem 'dart-rails'
-     ```
+  ```ruby
+  gem 'ruby-dart2js'
+  gem 'dart-rails'
+   ```
 
-  2. run `rails generate dart:assets` this will bring you:
+2. `rails generate dart:assets`
 
-    ```sh
-    rails g dart:assets
-    create  app/assets/dart
-    create  app/assets/dart/dart_app.dart
-    create  app/assets/dart/dart_app.js
-    create  app/assets/dart/pubspec.yaml
-    ```
+  ```sh
+  rails g dart:assets
+  create  app/assets/dart
+  create  app/assets/dart/dart_app.dart
+  create  app/assets/dart/dart_app.js.dart2js
+  create  app/assets/dart/pubspec.yaml
+  ```
 
-  3. Currently you still need to add following to the bottom of your body in the layout:
+3. asset links
 
-     `layout.html.erb` (for instance)
+    Now it's up to you wether you want to serve your `.dart` files and it's
+    compiled `.js` variant side-by-side or only one of those variants.
 
-    ```
-    <%= dart_include_tag 'dart_app' %>
-    <%= javascript_include_tag 'dart' %>
-    ```
+    - `.dart` and `.js`
 
-  4. *Optional:* run `rake pub:get` to respect the dependencies in your `pubspec.yaml`.
-  Initially the pubspec contains `rails_ujs` as dependency, this is just basic for now,
-  so you probably want to omit it if you're still using JQuery.
+        You'll need to add following to the bottom of your body in the layout
+        `layout.html.erb` (for instance)
 
-  *Note:* you'll need to point `DART_SDK_HOME` to the root of your dart-sdk unless your `pub` executable is in the `PATH`
+        ```
+        <%= dart_include_tag 'dart_app' %>
+        <%= javascript_include_tag 'dart' %>
+        ```
 
-### Compatibility ###
+    - `.js` only
+
+        simply add this to your `application.js`
+        ```
+        //= require dart_app
+        ```
+        While this would enable you to add several dart programs, there is no guarantee
+        it will work out. (untested)
+
+    - `.dart` only
+
+        You just need to add the `dart_include_tag` to the bottom of your body in the layout
+        `layout.html.erb` (for instance)
+
+        ```
+        <%= dart_include_tag 'dart_app' %>
+        ```
+
+
+4. `rake pub:get`
+
+    run `rake pub:get` to respect the dependencies in your `pubspec.yaml`.
+    Initially the pubspec contains `rails_ujs` as dependency, this is just basic for now,
+    so you probably want to omit it if you're still using JQuery.
 
+5. ruby-dart2js
+
+    See [ruby-dart2js](https://github.com/m0gg/ruby-dart2js) on github for setup.
+
+
+### Compatibility ###
 ###### UglifyJs ######
 
 Don't worry if you're experiencing a
@@ -68,55 +108,45 @@ You may simply disable UglifyJs in the environment file.
 
 ###### assets:precompile + native .dart files ######
 
-As of rails 4 we are facing a problem for the productive environments.
-See [Inability to compile nondigest and digest assets breaks compatibility with bad gems #49](https://github.com/rails/sprockets-rails/issues/49)
+*This is no longer relevant as there are no browsers that support native dart and
+should be used for production.*
 
-You may optionally add this to your Gemfile
+~~*Attention* currently not working with `rails >= 4.2`~~
+
+~~As of rails 4 we are facing a problem for the productive environments.
+See [Inability to compile nondigest and digest assets breaks compatibility with bad gems #49](https://github.com/rails/sprockets-rails/issues/49)~~
+
+~~You may optionally add this to your Gemfile~~
 
 ```
 gem 'non-stupid-digest-assets', '>= 1.1', github: 'm0gg/non-stupid-digest-assets'
 ```
 
-this will enable a workaround for digesting the assets while precompiling dart files as
+~~this will enable a workaround for digesting the assets while precompiling dart files as
 seen in [non-stupid-digest-assets](https://github.com/alexspeller/non-stupid-digest-assets) and
-additionally rewrite the manifests to use the non-digest files.
-
-###### ruby-dart2js ######
+additionally rewrite the manifests to use the non-digest files.~~
 
-This gem is needed for the `dart2js` compiler compatibility.
 
-See [ruby-dart2js](https://github.com/m0gg/ruby-dart2js) on github for setup.
+### Changelog ###
+v0.4.2 - 16. Dec 2015:
+  * full compat with sprockets 2 & 3 by switching to symlinked dart_app.js.dart2js
+  * fixed dart2js compilation by data
+  * requires `dart2js ~> 0.3.0`
 
-```
-<%= javascript_include_tag 'dart' %>
-```
-in the layout needs to stay as it is unless you want to drop
-compatibility for browsers without dart support.
-It includes the bundled `javascripts/dart.js` from this gem.
-
-This will parse all script-tags with `type="application/dart"` and replace them with tags that request
-the appropriate js file.
-```html
-<script type="application/dart" src="/assets/dart_app.dart"></script>
-```
-would get
-```html
-<script type="application/javascript" src="/assets/dart_app.js"></script>
-```
-To provide the transcompiled version of you dart-file you'll need a js template
-with a directive which could look like this
-```javascript
-//
-//= dart dart_app
-```
+v0.4.0 - 4. Dec. 2015:
+  * you now need a dart_app.js.dart2js template with following content:
 
-###### Sprockets ######
+  `app/assets/dart/dart_app.js.dart2js`
+  ```javascript
+  //= include dart_app.dart
+  ```
 
-`Dart::SprocketsDirectiveDart2js` extends Sprockets base `DirectiveProcessor` and thus each dart-file
-included (via `dart` directive) in `.js` templates get compiled and inserted.
+v0.3.3 - 9. Nov. 2015:
+  * support for sprockets-rails > 2.3.0
 
+v0.3.2-p1 - 9. Nov. 2015:
+  * remain support for sprockets-rails prior 2.3.0
 
-### Changelog ###
 v0.3.0 - 21. Jan. 2015:
   * with v0.2.0 of ruby-dart2js, minifying is supported and will bump the feature version of dart-rails with updated dependencies
 

data/lib/dart-rails.rb

@@ -1 +1,11 @@
 require 'dart/railtie'
+require 'dart/sprockets/dart2js_compiler'
+
+module Dart
+  case Sprockets::VERSION
+    when /^2/
+      Sprockets.register_engine '.dart2js', Dart2JsCompiler
+    when /^3/
+      Sprockets.register_engine '.dart2js', Dart2JsCompiler, mime_type: 'application/javascript'
+  end
+end

data/lib/dart/rails/generators/assets/templates/dart/dart_app.js.dart2js

@@ -0,0 +1,7 @@
+import 'package:rails_ujs/rails_ujs.dart';
+
+RailsUjs ujsHelper;
+
+void main() {
+  ujsHelper = new RailsUjs();
+}

data/lib/dart/rails/js_compat_engine.rb

@@ -7,26 +7,11 @@ module Dart #:nodoc:
       # Handle gem provided javascripts
       initializer :assets do |app|
 
-        #initialize dart2js dir
-        hash = (Digest::MD5.new << Time.now.to_s).to_s
-        DART2JS_OUT_DIR = app.root.join('tmp', 'cache', 'assets', 'development', 'dart', hash)
-        FileUtils.mkdir_p DART2JS_OUT_DIR unless File.directory?(DART2JS_OUT_DIR)
-
         # make dart.js compatibility-script accessible for sprockets
         app.assets.append_path(File.join(root, 'lib', 'assets', 'javascripts'))
 
-        # make dart2js results accessible for sprockets
-        app.assets.append_path(Dart::Rails::JsCompatEngine::DART2JS_OUT_DIR)
-
         # precompile compatibility-script(s)
-        # TODO: does not work with `app.assets.precompile += ...`
         ::Rails.application.config.assets.precompile += %w(dart_app.js dart.js)
-
-
-        # Mixin process_dart_directive in standard DirectiveProcessor for JS
-        Sprockets::DirectiveProcessor.instance_eval do
-          include Dart::DirectiveProcessorDart2js
-        end
       end
     end
   end

data/lib/dart/rails/version.rb

@@ -1,5 +1,5 @@
 module Dart #:nodoc:
   module Rails #:nodoc:
-    VERSION = '0.3.3'
+    VERSION = '0.4.3'
   end
 end

data/lib/dart/railtie.rb

@@ -1,33 +1,14 @@
 require 'rails'
 require 'rails/railtie'
-require 'dart/sprockets/directive_processor_dart2js'
 require 'dart/rails/version'
-require 'dart/rails/js_compat_engine'
 require 'dart/rails/dart_asset_helper'
+require 'dart/rails/js_compat_engine'
 require 'dart/rails/generators/assets/generator'
-require 'dart/rails/template_handler'
 
 
 module Dart #:nodoc:
   class Railtie < ::Rails::Railtie
 
-    # [Optionally via: https://github.com/m0gg/non-stupid-digest-assets]
-    # do not digest .dart files
-    # digest during compilation breaks darts 'import' functionality
-    # currently sprockets-rails does not allow mixed procompilation of digest and non-digest assets
-    # see https://github.com/rails/sprockets-rails/issues/49
-    # workaround is a 51-liner gem 'non-stupid-digest-assets'
-    # https://github.com/alexspeller/non-stupid-digest-assets
-    #
-    begin
-      require 'non-stupid-digest-assets'
-      if defined? NonStupidDigestAssets
-        NonStupidDigestAssets.whitelist += [ /.*\.dart/, 'dart_app.js', 'dart_app' ]
-      end
-    rescue Exception => e
-      puts 'No non-stupid-digest-assets support. You may face issues with native dart-support!'
-    end
-
     config.after_initialize do |app|
       # Mixin helper-module in ActionView
       ActionView::Base.instance_eval do

data/lib/dart/sprockets/dart2js_compiler.rb

@@ -0,0 +1,33 @@
+require 'tilt/template'
+require 'dart2js'
+
+module Dart
+  class Dart2JsCompiler < Tilt::Template
+    self.default_mime_type = 'application/javascript'
+
+    def self.engine_initialized?
+      defined? ::Dart2Js
+    end
+
+    def initialize_engine
+      unless defined? ::Dart2Js
+        require_template_library 'dart2js'
+      end
+    end
+
+    def prepare
+    end
+
+    def self.call(input)
+      # it's necessary for dart2js to have the dart file in th same directory as its depencencies
+      compiler = ::Dart2Js.new(input[:data], pwd: File.dirname(input[:filename]))
+      result = compiler.compile
+      compiler.close
+      result
+    end
+
+    def evaluate(context, locals, &block)
+      self.class.call({ filename: context.pathname, data: data })
+    end
+  end
+end

metadata

@@ -1,81 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: dart-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.3
 platform: ruby
 authors:
 - Marcel Sackermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: ruby-dart2js
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.2
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<="
+        version: 2.0.0
+    - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-    - - "<="
+        version: 2.0.0
+    - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
 description: Delivers .dart directly to Dartium-browser and compiles via ruby-dart2js
@@ -92,16 +72,14 @@ files:
 - lib/assets/javascripts/dart.js
 - lib/dart-rails.rb
 - lib/dart/rails/dart_asset_helper.rb
-- lib/dart/rails/dart_engine.rb
 - lib/dart/rails/generators/assets/generator.rb
 - lib/dart/rails/generators/assets/templates/dart/dart_app.dart
-- lib/dart/rails/generators/assets/templates/dart/dart_app.js
+- lib/dart/rails/generators/assets/templates/dart/dart_app.js.dart2js
 - lib/dart/rails/generators/assets/templates/dart/pubspec.yaml
 - lib/dart/rails/js_compat_engine.rb
-- lib/dart/rails/template_handler.rb
 - lib/dart/rails/version.rb
 - lib/dart/railtie.rb
-- lib/dart/sprockets/directive_processor_dart2js.rb
+- lib/dart/sprockets/dart2js_compiler.rb
 - lib/tasks/dart-rails_tasks.rake
 - test/dart-rails_test.rb
 - test/dummy/README.rdoc
@@ -158,33 +136,33 @@ signing_key:
 specification_version: 4
 summary: Provides Sprockets based handling of .dart files
 test_files:
-- test/dart-rails_test.rb
-- test/dummy/config.ru
+- test/test_helper.rb
+- test/dummy/Rakefile
+- test/dummy/config/application.rb
+- test/dummy/config/locales/en.yml
 - test/dummy/config/boot.rb
+- test/dummy/config/routes.rb
 - test/dummy/config/environment.rb
-- test/dummy/config/initializers/mime_types.rb
+- test/dummy/config/environments/test.rb
+- test/dummy/config/environments/development.rb
+- test/dummy/config/environments/production.rb
+- test/dummy/config/database.yml
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
+- test/dummy/config/initializers/session_store.rb
 - test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/application.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/routes.rb
-- test/dummy/config/database.yml
-- test/dummy/Rakefile
 - test/dummy/README.rdoc
+- test/dummy/config.ru
 - test/dummy/script/rails
+- test/dummy/public/500.html
 - test/dummy/public/favicon.ico
-- test/dummy/public/404.html
 - test/dummy/public/422.html
-- test/dummy/public/500.html
+- test/dummy/public/404.html
+- test/dummy/app/assets/javascripts/application.js
+- test/dummy/app/assets/stylesheets/application.css
 - test/dummy/app/controllers/application_controller.rb
 - test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/assets/javascripts/application.js
 - test/dummy/app/views/layouts/application.html.erb
-- test/test_helper.rb
+- test/dart-rails_test.rb

data/lib/dart/rails/dart_engine.rb

@@ -1,14 +0,0 @@
-require 'rails/engine'
-
-module Dart #:nodoc:
-  module Rails #:nodoc:
-    class DartEngine < ::Rails::Engine
-
-      initializer :assets do |app|
-
-        # Register mime-types
-        app.assets.register_mime_type 'application/dart', '.dart'
-      end
-    end
-  end
-end

data/lib/dart/rails/generators/assets/templates/dart/dart_app.js

@@ -1,2 +0,0 @@
-// dart directive issues dart2js-compilation
-//= dart dart_app

data/lib/dart/rails/template_handler.rb

@@ -1,22 +0,0 @@
-module Dart #:nodoc:
-  module Rails #:nodoc:
-
-    # TemplateHandler for dart scripts
-    class TemplateHandler
-      def self.erb_handler
-        debugger
-        @@erb_handler ||= ActionView::Template.registered_template_handler(:erb)
-      end
-
-      def self.call(template)
-        debugger
-        erb_handler.call(template)
-      end
-    end
-  end
-end
-
-# Finally register TemplateHandler in ActionView
-ActiveSupport.on_load(:action_view) do
-  ActionView::Template.register_template_handler :dart, Dart::Rails::TemplateHandler
-end

data/lib/dart/sprockets/directive_processor_dart2js.rb

@@ -1,63 +0,0 @@
-require 'fileutils'
-require 'dart2js'
-
-module Dart #:nodoc:
-  module DirectiveProcessorDart2js
-
-    def process_dart_directive(path)
-      dart_path = resolve([path, '.dart'].join, { base_path: @dirname })
-
-      process_depend_on_directive(dart_path)
-      dart_get_dependencies(dart_path).each do |dep|
-        process_depend_on_directive(dep)
-      end
-
-      #update Timestamp so we can compare possible changes
-      FileUtils.touch @filename
-
-      dart2js_compiler = ::Dart2Js.new(File.new(URI(dart_path).path), { out_dir: dart2js_out_dir })
-      result = dart2js_compiler.compile
-
-      if result.respond_to?(:exception)
-        puts "\n------------- dart2js compilation exception -------------\n#{result.message}\n#{result.result}\n------------- dart2js compilation exception -------------"
-        raise result
-      end
-
-      require_paths({ dart2js_compiler.out_file => @environment.stat(dart2js_compiler.out_file) }, Set.new)
-    end
-
-    private
-
-    DART_EGREP = /^(import|part) ['"]((dart:){0}|(package:))[0-9a-zA-Z_\/\.\-]+\.dart['"];/
-    DART_EGREP_PATH = /['"](package:)?(.*)['"]/
-
-    def dart_get_dependencies(pathname, exceptions=[])
-      deps = []
-      #recursive search
-      imports = dart_find_imports(pathname)
-      imports.each do |dep|
-        deps << dep unless deps.include?(dep)
-      end
-      (deps-exceptions).each do |path|
-        dart_get_dependencies(path, deps)
-      end
-      deps
-    end
-
-    def dart_find_imports(pathname)
-      deps = []
-      File.exists?(pathname) && File.readlines(pathname).each do |l|
-        #relevant line (import)?
-        next unless DART_EGREP =~ l
-        m = l.match(DART_EGREP_PATH)
-        #package or part?
-        deps << (m[1] ? resolve("packages/#{m[2]}") : "#{pathname.to_s.slice /^.*\//}#{m[2]}")
-      end
-      deps
-    end
-
-    def dart2js_out_dir
-      Dart::Rails::JsCompatEngine::DART2JS_OUT_DIR
-    end
-  end
-end