magic_frozen_string_literal 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6e04f9d975faac5b9bb731407d17810757891f2
-  data.tar.gz: 58d338693c0a50d2d9b08d35ed00e5d6fead18dc
+  metadata.gz: 80af2fba8814ca3b424f9ce5e49db53f539a15a3
+  data.tar.gz: d38df55bdcb2879fbaf57d566d9cdb4c2f44d4ef
 SHA512:
-  metadata.gz: 1f976e4559c85fd09341b00542bf6c8d2857a083c82da5b0e17444eed92e113cb2a74ab11b9268eb3d74bff20ee92e678a5bcc6be8abb3ffaefd2e2032deab96
-  data.tar.gz: a4473211577a551684095cc2875694e616797f0dc4b7fd5ffef0e4115adb7b829ef518b6a79bd05372f827001eb4bd4936a26e729da4c6a23a1f5114f112e987
+  metadata.gz: 224f8a43b2a67b80a79601f1ed7fa3ad8dafe72e0eac831e0098b8e4edd1a02a1ea08839d5e5d02a6175c1b15110a74ec62a12cd519ddc667ec0e7f8acacab38
+  data.tar.gz: 5c61397c08ad8b02280b64e5e35728e06e02da0c4f092b4ce337b468ed83b4ac4070e911fe9dec2890ed7330646ee988ca320129861f6557e228b5cc16ca528d

data/README.rdoc

@@ -17,10 +17,14 @@ you can call the tool from the console with default parameters like so
 
   magic_frozen_string_literal
 
-this will prepend every ".rb" file in the working directory (recursively) with the following line:
+this will prepend every ".rb", ".rake", ".rabl", ".jbuilder", ".haml", ".erb" file in the working directory (recursively)
+with the following magic comment followed by a blank line:
 
   # frozen_string_literal: true
 
+(".haml" files will have a "-" prefix before comment and no blank line after.
+".erb" files will have the comment inside <% ... %> and no blank line after.)
+
 Notes: 
 - existing frozen_string_literal magic comments are replaced
 - the rest of the file remains unchanged

data/lib/add_magic_comment.rb

@@ -3,17 +3,18 @@
 # A simple library to prepend magic comments to all Ruby files in a given folder
 
 module AddMagicComment
-  MAGIC_COMMENT_PREFIX  = "frozen_string_literal"
+  MAGIC_COMMENT_PREFIX  = "frozen_string_literal".freeze
   MAGIC_COMMENT_PATTERN = /^(-|(<%))?#\s*#{MAGIC_COMMENT_PREFIX}\s*(%>)?/
-  MAGIC_COMMENT         = "#{MAGIC_COMMENT_PREFIX}: true"
+  MAGIC_COMMENT         = "#{MAGIC_COMMENT_PREFIX}: true".freeze
+  EMPTY_LINE_PATTERN    = /^\s$/
 
   EXTENSION_COMMENTS = {
-    "rb"   => "# #{MAGIC_COMMENT}",
-    "rake" => "# #{MAGIC_COMMENT}",
-    "rabl" => "# #{MAGIC_COMMENT}",
-    "jbuilder" => "# #{MAGIC_COMMENT}",
-    "haml" => "-# #{MAGIC_COMMENT}",
-    "erb"  => "<%# #{MAGIC_COMMENT} %>"
+    "rb"        => "# #{MAGIC_COMMENT}\n\n",
+    "rake"      => "# #{MAGIC_COMMENT}\n\n",
+    "rabl"      => "# #{MAGIC_COMMENT}\n\n",
+    "jbuilder"  => "# #{MAGIC_COMMENT}\n\n",
+    "haml"      => "-# #{MAGIC_COMMENT}\n",
+    "erb"       => "<%# #{MAGIC_COMMENT} %>\n"
   }
 
   def self.process(argv)
@@ -28,12 +29,12 @@ module AddMagicComment
           lines = file.readlines
 
           # remove current encoding comment(s)
-          while lines.first && lines.first.match(MAGIC_COMMENT_PATTERN)
+          while lines.first && lines.first.match(MAGIC_COMMENT_PATTERN) || lines.first.match(EMPTY_LINE_PATTERN)
             lines.shift
           end
 
           # set current encoding
-          lines.insert(0, comment + "\n")
+          lines.insert(0, comment)
           count += 1
 
           file.pos = 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_frozen_string_literal
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Colin Kelley after Jared Roesch after Manuel Ryan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2018-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: 'Easily add magic comments ''# frozen_string_literal: true'' to multiple
-  Ruby source files'
+summary: 'Easily add magic comments ''# frozen_string_literal: true'' followed by
+  a blank line to multiple Ruby source files'
 test_files: []