dart-rails 0.3.2.pre.p1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e49471ffcb2c67b6a640073efcb54e7cbdc61da
+  data.tar.gz: deeba9f94a167824fcc7ed65fd34f5aa87764e02
+SHA512:
+  metadata.gz: cef071f90eb7a0efd96c1e8b0d8b62737fa1342682d3e4e61323cd071aa9c3bf3d4dd88fabf7dfe7f821e71dc7adde021ac1814ecc3345d51c86c28636fc0be1
+  data.tar.gz: 22f3fe694ff4ac91032c14ef460ab4d6bb0e88e8428187a8abbcfcc11e95a46d561eab0ae56efd2977ce2ab31153bd41fa3a6da66a673a635104769c458adb91

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 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.md

@@ -0,0 +1,176 @@
+dart-rails
+==========
+
+### Idea ###
+
+Handle [dart](https://www.dartlang.org/ 'dartlang.org') scripts so they get transcoded 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.
+
+For a working sample check [m0gg/dart-rails-sample](https://github.com/m0gg/dart-rails-sample 'm0gg/dart-rails-sample').
+
+### Setup ###
+
+  1. `Gemfile`
+
+    ```ruby
+    gem 'ruby-dart2js'
+    gem 'dart-rails'
+     ```
+
+  2. run `rails generate dart:assets` this will bring you:
+
+    ```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
+    ```
+
+  3. Currently you still need to add following to the bottom of your body in the layout:
+
+     `layout.html.erb` (for instance)
+
+    ```
+    <%= dart_include_tag 'dart_app' %>
+    <%= javascript_include_tag 'dart' %>
+    ```
+
+  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.
+
+  *Note:* you'll need to point `DART_SDK_HOME` to the root of your dart-sdk unless your `pub` executable is in the `PATH`
+
+### Compatibility ###
+
+###### UglifyJs ######
+
+Don't worry if you're experiencing a
+
+```
+ExecJS::ProgramError: RangeError: Maximum call stack size exceeded
+```
+
+This is exactly what it means, a stackoverflow of UglifyJs. According to
+[RangeError: Maximum call stack size exceeded #414](https://github.com/mishoo/UglifyJS2/issues/414) UglifyJs is
+massivly recursive and your dart2js file might have blown it. This happened to me with an AngluarDart application.
+You may simply disable UglifyJs in the environment file.
+
+```
+...
+# Compress JavaScripts and CSS.
+# config.assets.js_compressor = :uglifier
+...
+```
+
+###### 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)
+
+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
+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 ######
+
+This gem is needed for the `dart2js` compiler compatibility.
+
+See [ruby-dart2js](https://github.com/m0gg/ruby-dart2js) on github for setup.
+
+```
+<%= 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
+```
+
+###### Sprockets ######
+
+`Dart::SprocketsDirectiveDart2js` extends Sprockets base `DirectiveProcessor` and thus each dart-file
+included (via `dart` directive) in `.js` templates get compiled and inserted.
+
+
+### 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
+
+v0.2.5 - 14. Jan. 2015:
+  * fixed a misplaced initializer for non-stupid-digest-assets that caused every asset to be non-digested
+
+v0.2.4 - 13. Dec. 2014 - update:
+  * corrected `pubspec.yml` to assign valid `dart_app` as name
+
+v0.2.3 - 13. Dec. 2014:
+  * fix 2 issues documented as [Fix the generated pubspec.yml #13](https://github.com/m0gg/dart-rails/issues/13)
+  and [Generators run each time rails g runs #12](https://github.com/m0gg/dart-rails/issues/12)
+  * generators no longer try to run `rails g dart:assets` as javascript_engine
+  * generated `pubspec.yml` now staticly assigns `dart-app` as name
+  * railtie restructured and split into two engines
+
+v0.2.2 - 12. Dec. 2014 - update:
+  * dart-rails is now available via rubygems, it's first published with version 0.2.2
+
+v0.2.2 - 04. Dec. 2014:
+  * due to sprockets digest method, we are forced to use a workaround to allow
+  "precompilation" of .dart files, see [non-stupid-digest-assets](https://github.com/alexspeller/non-stupid-digest-assets)
+  and [Inability to compile nondigest and digest assets breaks compatibility with bad gems #49](https://github.com/rails/sprockets-rails/issues/49)
+  it is optionally (and automatically) available by adding `gem 'non-stupid-digest-assets', '>= 1.1', github: 'm0gg/non-stupid-digest-assets'
+` to your Gemfile
+  * added dart_app.js to precompile list
+  * faced an issue with UglifyJs stackoverflowing with too large dart2js files
+
+v0.2.1 - 18. Oct. 2014:
+  * dart2js compilation no longer recurses to infinity and further, this problem came uo to me while working with angularDart, which now compiles fine (takes some time though)
+  * sorry for dev-gap, been quite busy in university
+
+v0.2.0 - 08. Oct. 2014:
+  * dart-rails can now detect changes in dart code and its dependencies
+  * RailsUjs call is now in the initial dart_app.dart template
+  * fixed pathname to touch for change recognition
+  * renamed relevant constants to Dart2Js
+  * bumped ruby-dart2js version to 0.1.0
+
+v0.1.2 - 27. Sep. 2014:
+  * slightly different dart2js output directory-tree, now based on md5-hashed timestamps
+
+v0.1.1 - 29. Aug. 2014:
+  * dart-rails will no longer break assets:precompile
+
+v0.1.0 - 29. Aug. 2014:
+  * Note that `.dart2js` templates are no longer needed. Sprockets
+  DirectiveProcessor for Javascript ist now capable of including
+  dart2js-compiled scripts via a `//= dart dart_app` directive. See
+  updated sample application on github.
+  * Errors during dart2js compilation will now be handled by Sprockets
+  and thus the exception message will be thrown in the created js file.
+  For now there will be also an output on the console.
+  * As for newest SprocketsRails there is no longer the need of manually
+  adding `dart.js` to the precompilation list.
+  * Compiled scripts will reside in the `#{Rails.root}/tmp/cache/` directory.

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    = 'DartRails'
+  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/assets/javascripts/dart.js

@@ -0,0 +1,22 @@
+// Remap scripts for browsers that are not "Dartium"
+(function() {
+  if(navigator.userAgent.indexOf('(Dart)') === -1) {
+    var scripts = document.getElementsByTagName("script");
+    var length = scripts.length;
+    // run through all script tags and find the ones with type="application/dart"
+    for(var i = 0; i < length; ++i) {
+      if(scripts[i].type == "application/dart") {
+        if(scripts[i].src && scripts[i].src != '') {
+          var script = document.createElement('script');
+          // rewrite file extension to .js
+          script.src = scripts[i].src.replace(/\.dart(?=\?|$)/, '.js');
+          script.type = "application/javascript";
+          var parent = scripts[i].parentNode;
+          document.currentScript = script;
+          // finally replace script tag
+          parent.replaceChild(script, scripts[i]);
+        }
+      }
+    }
+  }
+})();

data/lib/dart-rails.rb

@@ -0,0 +1 @@
+require 'dart/railtie'

data/lib/dart/rails/dart_asset_helper.rb

@@ -0,0 +1,34 @@
+require 'action_view'
+
+module Dart #:nodoc:
+  module Rails #:nodoc:
+
+    # ActionView helper mixin for dart
+    module DartAssetHelper
+
+      # Returns html_safe dart/application script tag.
+      # Example:
+      #
+      #   '<script src="/assets/dart_app.dart" type="application/dart"></script>'
+      #
+      # Remember: only one dart script-tag is allowed!
+      def dart_include_tag(*sources)
+        options = sources.extract_options!.stringify_keys
+        sources.uniq.map { |source|
+          tag_options = {
+            'src' => dart_path(source, options),
+            'type' => 'application/dart'
+          }.merge(options)
+          content_tag(:script, '', tag_options)
+        }.join('\n').html_safe
+      end
+
+      # Returns path to dart script, similar to javascript_path
+      def dart_path(source, options = {})
+        path_to_asset(source, { :extname => '.dart' }.merge!(options))
+      end
+
+      alias_method :path_to_dart, :dart_path
+    end
+  end
+end

data/lib/dart/rails/dart_engine.rb

@@ -0,0 +1,14 @@
+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/generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Dart
+  module Generators
+    class AssetsGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Copies contents of template/dart to assets
+      # invoke with:
+      #
+      #   $# rails g dart:assets
+      #
+      def generate_dart
+        directory 'dart', 'app/assets/dart/'
+      end
+    end
+  end
+end

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

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

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

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

data/lib/dart/rails/generators/assets/templates/dart/pubspec.yaml

@@ -0,0 +1,4 @@
+name: dart_app
+description:
+dependencies:
+  rails_ujs: any

data/lib/dart/rails/js_compat_engine.rb

@@ -0,0 +1,33 @@
+require 'rails/engine'
+
+module Dart #:nodoc:
+  module Rails #:nodoc:
+    class JsCompatEngine < ::Rails::Engine
+
+      # 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
+end

data/lib/dart/rails/template_handler.rb

@@ -0,0 +1,22 @@
+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/rails/version.rb

@@ -0,0 +1,5 @@
+module Dart #:nodoc:
+  module Rails #:nodoc:
+    VERSION = '0.3.2-p1'
+  end
+end

data/lib/dart/railtie.rb

@@ -0,0 +1,38 @@
+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/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
+      ::Rails.logger.info '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
+        include Dart::Rails::DartAssetHelper
+      end
+    end
+  end
+end