magic_frozen_string_literal 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80af2fba8814ca3b424f9ce5e49db53f539a15a3
-  data.tar.gz: d38df55bdcb2879fbaf57d566d9cdb4c2f44d4ef
+  metadata.gz: ea34af2a4526f180999632150118a905ba15954a
+  data.tar.gz: c4c480187e8422e87c2ab91154360887b5e6a1b5
 SHA512:
-  metadata.gz: 224f8a43b2a67b80a79601f1ed7fa3ad8dafe72e0eac831e0098b8e4edd1a02a1ea08839d5e5d02a6175c1b15110a74ec62a12cd519ddc667ec0e7f8acacab38
-  data.tar.gz: 5c61397c08ad8b02280b64e5e35728e06e02da0c4f092b4ce337b468ed83b4ac4070e911fe9dec2890ed7330646ee988ca320129861f6557e228b5cc16ca528d
+  metadata.gz: d2c791c80c142890733e68c55ab4606648e53ae473991d3f57da80a1209868d5fcba930362b8f4c9a69e015fe7dad25cfe8308c22a9f6b85074a92cae8ec9e47
+  data.tar.gz: df218232b077d02775b593bfbd94997a20882f79424efdceb4cd3e55dd9a46433a1bcc6af59dc1b2e8b71c7a423162d5e7699e99b791b95a9b94b79e158d282e

data/README.rdoc

@@ -13,19 +13,22 @@ Cloned from https://github.com/m-ryan/magic_encoding
   
 == Usage
 
-you can call the tool from the console with default parameters like so
+Run the tool from the command line:
 
-  magic_frozen_string_literal
+  magic_frozen_string_literal <directory>
 
-this will prepend every ".rb", ".rake", ".rabl", ".jbuilder", ".haml", ".erb" file in the working directory (recursively)
+this will prepend every ".rb", ".rake", ".rabl", ".jbuilder", ".haml", ".slim", ".erb" file in the given <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.
+(".haml" and ".slim" files will have a "-" prefix before comment and no blank line after.
 ".erb" files will have the comment inside <% ... %> and no blank line after.)
 
+The <directory> parameter is optional. It defaults to the current working directory.
+
+
 Notes: 
-- existing frozen_string_literal magic comments are replaced
+- existing +frozen_string_literal+ magic comments are replaced
 - the rest of the file remains unchanged
 - empty files are not touched

data/bin/magic_frozen_string_literal

@@ -2,6 +2,6 @@
 
 # A simple tool to prepend magic '# frozen_string_literal: true' comments to multiple ".rb" files
 
-require 'add_magic_comment'
+require_relative '../lib/add_magic_comment'
 
 AddMagicComment.process(ARGV)

data/lib/add_magic_comment.rb

@@ -7,6 +7,7 @@ module AddMagicComment
   MAGIC_COMMENT_PATTERN = /^(-|(<%))?#\s*#{MAGIC_COMMENT_PREFIX}\s*(%>)?/
   MAGIC_COMMENT         = "#{MAGIC_COMMENT_PREFIX}: true".freeze
   EMPTY_LINE_PATTERN    = /^\s$/
+  SHEBANG_PATTERN       = /^#!/
 
   EXTENSION_COMMENTS = {
     "rb"        => "# #{MAGIC_COMMENT}\n\n",
@@ -14,7 +15,8 @@ module AddMagicComment
     "rabl"      => "# #{MAGIC_COMMENT}\n\n",
     "jbuilder"  => "# #{MAGIC_COMMENT}\n\n",
     "haml"      => "-# #{MAGIC_COMMENT}\n",
-    "erb"       => "<%# #{MAGIC_COMMENT} %>\n"
+    "slim"      => "-# #{MAGIC_COMMENT}\n",
+    "erb"       => "<%# #{MAGIC_COMMENT} -%>\n"
   }
 
   def self.process(argv)
@@ -24,18 +26,27 @@ module AddMagicComment
     EXTENSION_COMMENTS.each do |ext, comment|
       filename_pattern = File.join(directory, "**", "*.#{ext}")
       Dir.glob(filename_pattern).each do |filename|
-        next unless File.size(filename) > 0
         File.open(filename, "r+") do |file|
           lines = file.readlines
+          next unless lines.any?
+          count += 1
+
+          if lines.first =~ SHEBANG_PATTERN
+            shebang = lines.shift
+          end
 
-          # remove current encoding comment(s)
-          while lines.first && lines.first.match(MAGIC_COMMENT_PATTERN) || lines.first.match(EMPTY_LINE_PATTERN)
+          # remove current magic comment(s)
+          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)
-          count += 1
+          # add magic comment as the first line
+          lines.unshift(comment)
+
+          # put shebang back
+          if shebang
+            lines.unshift(shebang)
+          end
 
           file.pos = 0
           file.puts(lines.join)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magic_frozen_string_literal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Colin Kelley after Jared Roesch after Manuel Ryan