asset_bom_removal-rails 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a279fa505b26ae133d589793a3e8dbaa44a15f70
-  data.tar.gz: f8fff0e413f923bda7b32cd4f70c66c47b156fc5
+  metadata.gz: 381a294cc4dd9977a510e893fe2f9dd81ae486b5
+  data.tar.gz: 6e8f9dc7823e96cf51c88260978c144d4b9ed8ab
 SHA512:
-  metadata.gz: 52ad807c5ea9ad11d25f735f6ca24dc1069914e876560d49004b454caf332e4b1f46419f00980e0663cb7781b21f898ca4cb01aadda7763276f92b13cfb6d0d8
-  data.tar.gz: a80d661216b619a5f4cb34069528f8de38b0f24743ccd6eadef36cae605abc4b5b148835f6039b7af72dc28d8e7df559034d182fb18625384f58db1422c6c091
+  metadata.gz: f98cd01d5645921978ae90a96a07980c95e530673085489342e979e4c3a40a414b3c01d198f7875ff5695e4d0a4a03670a0f951201affaf9ac13ffe4490c1385
+  data.tar.gz: cd75f89bce9d5065f70b8fbbbbfd29abfd8fa797ed229ef530a59d264f73292427262e7cb441f585ce8710c3fc45f60dd24fcd40b4af11c2c31a9fd4bf4f8a1f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.1
+
+* Fix issue where BOM removal strips 2 extra characters from file [#6](https://github.com/alphagov/asset_bom_removal-rails/pull/6)
+* Improve Readme [#5](https://github.com/alphagov/asset_bom_removal-rails/pull/5)
+
 # 1.0.0
 
-* Hooks into Rails Asset Pipeline as a custom Sass Compressor that strips the utf-8 BOM from compressed css
+* Hooks into Rails Asset Pipeline as a custom Sass Compressor that strips the utf-8 BOM from compressed css [#3](https://github.com/alphagov/asset_bom_removal-rails/pull/3)

data/README.md

@@ -1,8 +1,16 @@
-# Asset::Bom::Removal::Rails
+# AssetBomRemoval::Rails
 
-This gem hooks into [Rails `assets:precompile` task](http://guides.rubyonrails.org/asset_pipeline.html#precompiling-assets) and removes the BOM from any CSS files (and their gzipped versions) in the asset root.
+This gem hooks into [Rails `assets:precompile` task](http://guides.rubyonrails.org/asset_pipeline.html#precompiling-assets) and removes the [UTF8 Byte Order Mark (BOM)]((https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8)) from any CSS files compressed by [Sass](https://github.com/sass/sass-rails/).
 
-We do this because we want to use [SRI](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) on our assets, but [a bug in Firefox versions < 52](https://bugzilla.mozilla.org/show_bug.cgi?id=1269241) means it calculates the hash incorrectly when the CSS asset has a [UTF-8 BOM](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) and refuses to load the asset.  The BOM is [generated by SASS versions > 3.4](https://github.com/sass/sass/blob/3.4.0/lib/sass/tree/visitors/to_css.rb#L131-L140) when the CSS file includes utf-8 characters and in the versions of rails, sass, sprockets, sass-rails, and sprockets-rails we use it is impossible to configure SASS to stop doing this (as mentioned [in the sass-rails readme](https://github.com/rails/sass-rails/blob/v4.0.0/README.md#configuration) from version 4.0+).
+## What is a BOM?
+
+The BOM is a sequence of bytes at the start of a unicode text file that are used to tell the computer how to interpret the contents.  The BOM is required for UTF-16 because you can write the bytes for each character in big or little endian form.  This gem does not remove the UTF-16 BOM.  The BOM is optional for UTF-8 files as the standard says there is only one way to write the bytes for each character.  Adding it to a file is a hint to the computer for how to interpret the file, but can be safely removed without changing how the file will be interpreted.
+
+## Why remove it?
+
+We do this because we want to use [SRI](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) on our assets to let users know that neither the assets nor the html have been intercepted and changed between our server and their browser.  Unfortunately [a bug in Firefox versions < 52](https://bugzilla.mozilla.org/show_bug.cgi?id=1269241) means it calculates the hash incorrectly when the CSS asset has a UTF-8 BOM and refuses to load the asset.
+
+The BOM is [generated by SASS versions > 3.4](https://github.com/sass/sass/blob/3.4.0/lib/sass/tree/visitors/to_css.rb#L131-L140) when the CSS file includes utf-8 characters and in the versions of [rails](https://github.com/rails/rails), [sass](https://github.com/sass/sass), [sprockets](https://github.com/rails/sprockets), [sass-rails](https://github.com/rails/sass-rails), and [sprockets-rails](https://github.com/rails/sprockets-rails) we use it is impossible to configure Sass to stop doing this (as mentioned [in the sass-rails readme](https://github.com/rails/sass-rails/blob/v4.0.0/README.md#configuration) from version 4.0+).
 
 ## Installation
 

data/lib/asset_bom_removal/bom_remover.rb

@@ -0,0 +1,40 @@
+module AssetBomRemoval
+  class BomRemover
+    def self.remove_bom(string)
+      new(string).remove_bom
+    end
+
+    def initialize(string)
+      @string = string
+    end
+
+    def remove_bom
+      if string_starts_with_utf8_bom?
+        string.dup.force_encoding('UTF-8').tap do |utf8_string|
+          utf8_string.slice!(0)
+        end
+      else
+        string
+      end
+    end
+
+  private
+
+    attr_reader :string
+
+    def string_starts_with_utf8_bom?
+      with_encoding('UTF-8') do |utf8_string|
+        utf8_string[0] == "\xEF\xBB\xBF"
+      end
+    end
+
+    def with_encoding(encoding)
+      old_encoding = string.encoding
+      begin
+        return (yield string.force_encoding(encoding))
+      ensure
+        string.force_encoding(old_encoding)
+      end
+    end
+  end
+end

data/lib/asset_bom_removal/rails/version.rb

@@ -1,5 +1,5 @@
 module AssetBomRemoval
   module Rails
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.0.1'.freeze
   end
 end

data/lib/asset_bom_removal/sass_no_bom_compressor.rb

@@ -4,17 +4,7 @@ module AssetBomRemoval
   class SassNoBomCompressor < Sprockets::SassCompressor
     # Let the default sass processor do all the hard work
     def call(input)
-      remove_bom_from_css(super(input))
-    end
-
-  private
-
-    def remove_bom_from_css(css_string)
-      if css_string.bytes[0..2] == [0xEF, 0xBB, 0xBF]
-        css_string[3..-1]
-      else
-        css_string
-      end
+      BomRemover.remove_bom(super(input))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asset_bom_removal-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2017-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -113,6 +113,7 @@ files:
 - README.md
 - Rakefile
 - asset_bom_removal-rails.gemspec
+- lib/asset_bom_removal/bom_remover.rb
 - lib/asset_bom_removal/rails.rb
 - lib/asset_bom_removal/rails/railtie.rb
 - lib/asset_bom_removal/rails/version.rb