webshims-rails 1.15.6 → 1.15.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2a250a396c3e4575c9554236d514bad8290e5f6
-  data.tar.gz: f90db279b3ca307408ff113748796d1e460b82b3
+  metadata.gz: fdf1f995975ae4c129c02f82c24522642b676fb1
+  data.tar.gz: 753b6472f5f2670b6d6c4e4ca15f5a009ca33a15
 SHA512:
-  metadata.gz: 0402b922725d3d57f5f8a44de06cb8779591a4e0f32792b031f516fc077701a48a3e69697afa3cb9a0b055fd88b0ce30035c0e6d37828e210121349e4a2a4028
-  data.tar.gz: 3aaf77b51124c8aa9d1bd092d7134290e94977c142e70146f3d027cb77670d8e7807a6b71cbc06781b15962afc2aa6602d0cf3560445b8045cc934bb913fdc1c
+  metadata.gz: 57ab7d675bc47b9f9036c487a7b47d325de0141b8e032af26c6665e2ffb7277c0a1324bb051418f9ee9a437550d30b57b2833e17333f645c88b077e429c55c24
+  data.tar.gz: 7566027b1490239a0b57b6620258cbcc463f579f24be88a7a04f4c56da2db953ffe87b12bd08f45eed2c3d9b1c49cb934bc67f14b6d6005451cfda9f93eb1275

data/CHANGES.md

@@ -1,3 +1,7 @@
+2015-01-19
+-------------------
+* Stopped adding webshims to the default assets-precompile list for Rails 4. This should only affect current Rails 4 users who are working around digest-only precompiling; they will need to add `config.assets.precompile << /webshims/` to their application.rb.
+
 2015-01-04
 -------------------
 * Removed modernizr-custom from documentation, since webshims has removed its custom modernizr build. If your app depends on Modernizr, you'll have to build and include your own version.

data/README.md

@@ -0,0 +1,63 @@
+# Webshims-rails
+
+Easily include the "webshims library":http://aFarkas.github.com/webshim/demos/index.html (by Alexander Farkas) in your Rails 3.1+ project with the asset pipeline.
+
+## Note on Changes in Rails 4
+
+With the release of Rails 4 and an updated [sprockets-rails](https://github.com/rails/sprockets-rails#changes-from-rails-3x gem), only digest filenames are compiled when running rake assets:precompile (non-digest filenames are no longer compiled).
+
+Since webshims does not support fingerprinting, this will result in 404s (missing assets) in production mode. To avoid this, you have two options:
+
+1. Run this rake task every time you update webshims:
+
+  ```bash
+  rake webshims:update_public
+  ```
+
+  This copies the webshims directory into the public/ directory. Then, alter step 3 below to re-configure your basePath from public/assets (as it was in Rails 3.X) to public/:
+
+  ```javascript
+  $.webshims.setOptions('basePath', '/webshims/shims/')
+  ```
+2. Or, turn (back) on asset compiling with non-digest filenames, with, for example, this gist: https://gist.github.com/eric1234/5692456. Don't forget that, if you go this direction, you'll also have to add webshims to the assets that are precompiled by default: `config.assets.precompile << /webshims/` in application.rb.
+
+
+## Usage
+
+1. Add webshims-rails to your Gemfile for bundler: `gem 'webshims-rails'`
+2. Require the webshims polyfiller, eg, in your application.js:
+
+  ```javascript
+  //= require webshims/polyfiller
+  ```
+
+  *Update note:* Previous webshims versions included a custom modernizr build; this was removed in webshims 1.14.6, so the (previously necessary) `require webshims/extras/modernizr-custom` line should be removed, and if your app requires modernizr, you'll have to build and require it yourself.
+
+3. In your javascript, after the polyfiller has been required, set the basePath for webshims as shown below, and then call $.webshims.polyfill(); see webshims docs for more options.
+   (Note that this should be run directly, not in a dom-ready block.)
+
+  ```javascript
+  $.webshims.setOptions('basePath', '/assets/webshims/shims/')
+  $.webshims.polyfill()
+  ```
+
+4. For Turbolinks users only: you'll need to update the polyfill on page load:
+
+  ```coffeescript
+  $(document).on "page:load", ->
+    $(this).updatePolyfill()
+  ```
+
+## Updating this gem
+
+This is only in the case this repository is not up-to-date; I try to stay current with webshims but sometimes I miss the webshims releases.
+
+There's a quick-and-dirty rake task in the repository to checkout webshims from github, checkout a git ref, and copy the required scripts over. You need to specify the Webshims-rails version and the git reference (version/tag/sha) from the webshims repository.
+
+```bash
+rake update VERSION=1.14.5 REF=1.14.5
+```
+
+## License
+
+MIT licensed, like the Webshims library.

data/lib/webshims-rails.rb

@@ -4,9 +4,13 @@ module Webshims
   module Rails
     class Engine < ::Rails::Engine
       # Everything in the webshims directory should be precompiled, since
-      # it all needs to be accessed dynamically depending on the browser
-      initializer :append_webshims_assets_path, :group => :all do |app|
-        app.config.assets.precompile << /webshims/
+      # it all needs to be accessed dynamically depending on the browser.
+      # Turning this off by default for Rails 4, since in that case, users
+      # are already using a workaround and likely do not need to precompile.
+      unless ::Rails::VERSION::MAJOR >= 4
+        initializer :append_webshims_assets_path, :group => :all do |app|
+          app.config.assets.precompile << /webshims/
+        end
       end
     end
   end

data/lib/webshims-rails/version.rb

@@ -1,6 +1,6 @@
 module Webshims
   module Rails
-    VERSION = "1.15.6"
+    VERSION = "1.15.6.2"
     WEBSHIMS_VERSION = "1.15.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webshims-rails
 version: !ruby/object:Gem::Version
-  version: 1.15.6
+  version: 1.15.6.2
 platform: ruby
 authors:
 - David Reese
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,11 +36,11 @@ files:
 - CHANGES.md
 - Gemfile
 - MIT_LICENSE.txt
+- README.md
 - Rakefile
 - lib/tasks/webshims.rake
 - lib/webshims-rails.rb
 - lib/webshims-rails/version.rb
-- readme.textile
 - vendor/assets/javascripts/webshims/polyfiller.js
 - vendor/assets/javascripts/webshims/shims/FlashCanvas/canvas2png.js
 - vendor/assets/javascripts/webshims/shims/FlashCanvas/flashcanvas.js

data/readme.textile

@@ -1,51 +0,0 @@
-h1. Webshims-rails
-
-Easily include the "webshims library":http://aFarkas.github.com/webshim/demos/index.html (by Alexander Farkas) in your Rails 3.1+ project with the asset pipeline.
-
-h2. Note on Changes in Rails 4
-
-With the release of Rails 4 and an updated "sprockets-rails":https://github.com/rails/sprockets-rails#changes-from-rails-3x gem, only digest filenames are compiled when running rake assets:precompile (non-digest filenames are no longer compiled).
-
-Since webshims does not support fingerprinting, this will result in 404s (missing assets) in production mode. To avoid this, you have two options:
-
-One, turn (back) on asset compiling with non-digest filenames, with, for example, this gist: https://gist.github.com/eric1234/5692456
-
-Or two, run
-<pre>
-$ rake webshims:update_public
-</pre>
-which copies the webshims directory into the public/ directory. Then, alter step 3 below to re-configure your basePath from public/assets (as it was in Rails 3.X) to public/:
-<pre>
-$.webshims.setOptions('basePath', '/webshims/shims/')
-</pre>
-
-h2. Usage
-
-1. Add webshims-rails to your Gemfile for bundler: @gem 'webshims-rails'@
-2. Require the webshims polyfiller, eg, in your application.js:
-
-<pre>
-//= require webshims/polyfiller
-</pre>
-
-*Update note:* Previous webshims versions included a custom modernizr build; this was removed in webshims 1.14.6, so the (previously necessary) `require webshims/extras/modernizr-custom` line should be removed, and if your app requires modernizr, you'll have to build and require it yourself.
-
-3. In your javascript, after the polyfiller has been required, set the basePath for webshims as shown below, and then call $.webshims.polyfill(); see webshims docs for more options.
-(Note that this should be run directly, not in a dom-ready block.)
-
-<pre>
-  $.webshims.setOptions('basePath', '/assets/webshims/shims/')
-  $.webshims.polyfill()
-</pre>
-
-h2. Updating
-
-There's a quick-and-dirty rake task in the repository to checkout webshims from github, checkout a git ref, and copy the required scripts over. You need to specify the Webshims-rails version and the git reference (version/tag/sha) from the webshims repository.
-
-<pre>
-  rake update VERSION=1.14.5 REF=1.14.5
-</pre>
-
-h2. License
-
-MIT licensed, like the Webshims library.