onload-transformer 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc48aa1c187e9a812f198ff52b38cc0206f45749
+  data.tar.gz: 289f674f9f154994bdf625c8f50de266fc541319
+SHA512:
+  metadata.gz: 951abd2dfece8bbb097f77143d5194f25919651ff889f128d2b55a642eccd80b64030346cc57ce58807377360956f8e9335cdf6d9cda0794600f9721753cc325
+  data.tar.gz: 5a0086a6edd3e315e29c24d098dcede4330923f2c95a80f8516b215fdb1e60cd3c84226a98a6bd95e15fbd5efccb5303562d36327d009ec5563b859cdc0df59b

data/.gitignore

@@ -0,0 +1,3 @@
+tmp/
+tags
+.ruby-version

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2019 Jérémie Bonal
+
+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,27 @@
+# Onload Transformer for Sprockets
+
+## What?
+
+It's a small transformer for Sprockets that allows you to make a JS file wait for the document's `DOMContentLoaded` instead of running right when read.
+
+## Why?
+
+Because vendors sometimes provide minified JS that's meant to be copy-pasted at the end of your page, but you don't want to do that because of turbolinks, personal conviction or other, but if you serve it through your asset pipeline you end up running it before your DOM is ready.
+Or you can use it to never write a `$(document).ready` again in your life I guess? I'm not the boss of you, use it for whatever you find it useful for.
+
+## How? (does it work)
+
+It just wraps the whole file in a function and then binds it to the `DOMContentLoaded` event (with the proper check beforehand in case the DOM is already loaded).
+
+## How? (do i use it)
+
+- Add the gem to your gemfile.
+- Use the extension .onload.js instead of .js for your files.
+
+## What? (can be improved)
+
+Probably a lot of stuff, but at least:
+
+[ ] - The functions used to wrap the body of the file are in the global namespace. It would be better if they were defined on a transformer-only object.
+[ ] - Make it so it can be used with .js.erb / .js.coffee (maybe ?)
+

data/lib/onload-transformer.rb

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

data/lib/sprockets/onload_transformer.rb

@@ -0,0 +1,42 @@
+require 'sprockets'
+
+module Sprockets
+  class OnloadTransformer
+    def self.call(input)
+      asset_name = input[:name]
+      body = input[:data]
+      util_function_name = "onloadTransformerUtil#{to_function_key(asset_name)}"
+      wrapped_in_event = <<-JS
+        function #{util_function_name}() {
+          #{body}
+        };
+
+        if (document.readyState === "loading") {
+          document.addEventListener("DOMContentLoaded", #{util_function_name});
+        } else {
+          #{util_function_name}();
+        };
+      JS
+
+      { data: wrapped_in_event }
+    end
+
+    def self.to_function_key(key)
+      key.parameterize.underscore.camelize
+    end
+  end
+
+  if respond_to?(:register_transformer)
+    register_mime_type 'application/onload-javascript', extensions: ['.onload.js'], charset: :unicode
+    register_transformer 'application/onload-javascript', 'application/javascript', OnloadTransformer
+    register_preprocessor 'application/onload-javascript', DirectiveProcessor
+  end
+
+  if respond_to?(:register_engine)
+    args = ['.onload.js',  OnloadTransformer]
+    if Sprockets::VERSION.start_with?("3")
+      args << { mime_type: 'application/javascript', silence_deprecation: true }
+    end
+    register_engine(*args)
+  end
+end

data/lib/sprockets/onload_transformer/version.rb

@@ -0,0 +1,5 @@
+module Sprockets
+  class OnloadTransformer
+    VERSION = '0.2.0'
+  end
+end

data/onload-transformer.gemspec

@@ -0,0 +1,16 @@
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'sprockets/onload_transformer/version'
+
+Gem::Specification.new do |s|
+  s.name = "onload-transformer"
+  s.authors = ["Jérémie Bonal"]
+  s.email = ["jeremie.bonal@gmail.com"]
+  s.version = Sprockets::OnloadTransformer::VERSION
+  s.summary = "A short extension of Sprockets to wrap JS libs so they wait for DOMContentLoaded"
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.license = "MIT"
+  s.homepage = "http://github.com/Aquaj/onload-transformer"
+
+  s.add_dependency 'sprockets', '>= 2.0', '<= 4'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: onload-transformer
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jérémie Bonal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- jeremie.bonal@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- lib/onload-transformer.rb
+- lib/sprockets/onload_transformer.rb
+- lib/sprockets/onload_transformer/version.rb
+- onload-transformer.gemspec
+homepage: http://github.com/Aquaj/onload-transformer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2.2
+signing_key: 
+specification_version: 4
+summary: A short extension of Sprockets to wrap JS libs so they wait for DOMContentLoaded
+test_files: []