magic_frozen_string_literal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3d4cf03b86472104ca49183f5166a4f2f990539
+  data.tar.gz: 52df99a2ea7dc7a14db1dcfbb73600715a44560e
+SHA512:
+  metadata.gz: 59fc7a3c9f698ed9e01fe06d1069869f63c4535fd9215e19af0efdce9021381bda32e0b4cae8ef70416c264abd3eac1f6852abe6bdaaca68efa8dc0df149df85
+  data.tar.gz: 381a8847c20c6c1a95c5c8ef9e3298e75baa098429bb7032d3b87c5b68cf91393cfed8f79397074dafa81852a6f2bb46551d5ffacba5d8e4c4541fecb6ef7953

data/CHANGELOG

@@ -0,0 +1,8 @@
+## 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

data/LICENCE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Manuel Ryan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,25 @@
+= Magic_frozen_string_literal
+
+Magic_frozen_string_literal is a little tool that allows you to quickly 
+add the magic comment that indicates that the file
+can safely have its string literals frozen, as will be {the default in Ruby 3.0}[https://bugs.ruby-lang.org/issues/8976].
+
+Cloned from https://github.com/m-ryan/magic_encoding
+
+== Installation
+
+  gem install magic_frozen_string_literal
+  
+== Usage
+
+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:
+
+  # frozen_string_literal: true
+
+Notes: 
+- existing frozen_string_literal magic comments are replaced
+- the rest of the file remains unchanged

data/bin/magic_frozen_string_literal

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# A simple tool to prepend magic '# frozen_string_literal: true' comments to multiple ".rb" files
+
+require 'add_magic_comment'
+
+AddMagicComment.process(ARGV)

data/lib/add_magic_comment.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# A simple library to prepend magic comments to multiple ".rb" files
+
+module AddMagicComment
+  MAGIC_COMMENT_PREFIX  = "frozen_string_literal"
+  MAGIC_COMMENT_PATTERN = /^-?# *#{MAGIC_COMMENT_PREFIX}/
+  MAGIC_COMMENT         = "#{MAGIC_COMMENT_PREFIX}: true"
+
+  EXTENSIONS = {
+    'rb'   => '# {text}',
+    'rake' => '# {text}',
+    'haml' => '-# {text}',
+  }
+
+  # Options :
+  # 1 : Encoding
+  # 2 : Path
+  # TODO : check that the encoding specified is a valid encoding
+  # TODO : allow use of only one option, so the encoding would be guessed (maybe using `file --mime`?)
+  def self.process(options)
+
+    directory = options[0] || Dir.pwd
+
+
+    # TODO : add options for recursivity (and application of the script to a single file)
+
+    count = 0
+    EXTENSIONS.each do |ext, comment_style|
+      rbfiles = File.join(directory, "**", "*.#{ext}")
+      Dir.glob(rbfiles).each do |filename|
+        File.open(filename, "r+") do |file|
+          lines = file.readlines
+
+          # remove current encoding comment(s)
+          while lines[0].match(MAGIC_COMMENT_PATTERN)
+            lines.shift
+          end
+
+          # set current encoding
+          lines.insert(0, comment_style.sub('{text}', MAGIC_COMMENT + "\n"))
+          count += 1
+
+          file.pos = 0
+          file.puts(lines.join)
+        end
+      end
+    end
+
+    puts "Magic comments added to #{count} source file(s)"
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: magic_frozen_string_literal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Colin Kelley after Jared Roesch after Manuel Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- colin@invoca.com
+executables:
+- magic_frozen_string_literal
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG
+- LICENCE
+- README.rdoc
+- bin/magic_frozen_string_literal
+- lib/add_magic_comment.rb
+homepage: https://github.com/Invoca/magic_frozen_string_literal
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: 'Easily add magic comments ''# frozen_string_literal: true'' on multiple
+  ruby source files'
+test_files: []