magic_frozen_string_literal 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 80af2fba8814ca3b424f9ce5e49db53f539a15a3
-  data.tar.gz: d38df55bdcb2879fbaf57d566d9cdb4c2f44d4ef
+SHA256:
+  metadata.gz: f54032084880af90e371bb807f2128440ab0a843e4a31e896c2ce27704feabdf
+  data.tar.gz: 9354d05727956a10a7cf0f5a7d71959ac27e904a4e5ea40262d0c4895658569f
 SHA512:
-  metadata.gz: 224f8a43b2a67b80a79601f1ed7fa3ad8dafe72e0eac831e0098b8e4edd1a02a1ea08839d5e5d02a6175c1b15110a74ec62a12cd519ddc667ec0e7f8acacab38
-  data.tar.gz: 5c61397c08ad8b02280b64e5e35728e06e02da0c4f092b4ce337b468ed83b4ac4070e911fe9dec2890ed7330646ee988ca320129861f6557e228b5cc16ca528d
+  metadata.gz: fa79c8714e7305a0eb0924032e4be3cf212816ade15919d450ad156eae13c4bae0cc453633b6438824a4a7bfa78fba9f8dbd3d4e6a32d10855e4d581c950bd1a
+  data.tar.gz: 70ec12b6d6ad8e6d60843bae33585170f3ec58c6c6f78c2fff6c369f77fe25c13c6eca52a72e323a91bcb23e5d0bfff1ba096ea5be1bcbcac3ae9da40a544c64

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", "*.ru", "Rakefile", "*.rake", "Gemfile", "*.gemspec", "*.rabl", "*.jbuilder", "*.haml", "*.slim" 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.
-".erb" files will have the comment inside <% ... %> and no blank line after.)
+(".haml" and ".slim" files will have a "-" prefix before the comment 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
+- if the file starts with #! (shebang), that line is preserved and the magic comment is added just below it

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,38 +7,53 @@ 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",
-    "rake"      => "# #{MAGIC_COMMENT}\n\n",
-    "rabl"      => "# #{MAGIC_COMMENT}\n\n",
-    "jbuilder"  => "# #{MAGIC_COMMENT}\n\n",
-    "haml"      => "-# #{MAGIC_COMMENT}\n",
-    "erb"       => "<%# #{MAGIC_COMMENT} %>\n"
+    "*.rb"        => "# #{MAGIC_COMMENT}\n\n",
+    "*.ru"        => "# #{MAGIC_COMMENT}\n\n",
+    "Rakefile"    => "# #{MAGIC_COMMENT}\n\n",
+    "*.rake"      => "# #{MAGIC_COMMENT}\n\n",
+    "Gemfile"     => "# #{MAGIC_COMMENT}\n\n",
+    "*.gemspec"   => "# #{MAGIC_COMMENT}\n\n",
+    "*.rabl"      => "# #{MAGIC_COMMENT}\n\n",
+    "*.jbuilder"  => "# #{MAGIC_COMMENT}\n\n",
+    "*.haml"      => "-# #{MAGIC_COMMENT}\n",
+    "*.slim"      => "-# #{MAGIC_COMMENT}\n"
   }
 
   def self.process(argv)
     directory = argv.first || Dir.pwd
 
     count = 0
-    EXTENSION_COMMENTS.each do |ext, comment|
-      filename_pattern = File.join(directory, "**", "*.#{ext}")
+    EXTENSION_COMMENTS.each do |pattern, comment|
+      filename_pattern = File.join(directory, "**", "#{pattern}")
       Dir.glob(filename_pattern).each do |filename|
-        next unless File.size(filename) > 0
-        File.open(filename, "r+") do |file|
+        File.open(filename, "rb+") do |file|
           lines = file.readlines
+          newline = detect_newline(lines.first)
+          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.gsub("\n", newline))
+
+          # put shebang back
+          if shebang
+            lines.unshift(shebang)
+          end
 
           file.pos = 0
-          file.puts(lines.join)
+          file.print(*lines)
           file.truncate(file.pos)
         end
       end
@@ -46,4 +61,8 @@ module AddMagicComment
 
     puts "Magic comments added to #{count} source file(s)"
   end
+
+  def self.detect_newline(line)
+    (line[/\R/] if line) || $/
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: magic_frozen_string_literal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Colin Kelley after Jared Roesch after Manuel Ryan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-18 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 description: 
 email:
 - colin@invoca.com
@@ -46,7 +60,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
 - LICENCE
 - README.rdoc
 - bin/magic_frozen_string_literal
@@ -54,7 +67,8 @@ files:
 homepage: https://github.com/Invoca/magic_frozen_string_literal
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -70,8 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: 'Easily add magic comments ''# frozen_string_literal: true'' followed by

data/CHANGELOG

@@ -1,8 +0,0 @@
-## 0.0.1 (August 3, 2010)
-
-Initial Version
-
-## 0.0.2 (August 3, 2010)
-
-Existing magic comments are now erased before the file is prepended with the desired magic comment
-Bugfixes