magic_encoding_just_for_ruby 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f454a337642b4044d1ed4c72f29d3c719783306
+  data.tar.gz: 06e2ce258618bc6776daa05c560018ac2a08a862
+SHA512:
+  metadata.gz: 337668cf7f20ff1430f707ace408a84ff1df2204739762e86476000b2a79bc2a4461da1f5f6012152d1a98634a8acd31062aea592784f71f5a45d81c636a7203
+  data.tar.gz: fe66f8d2b882541fd3b778965d32bb5023f7d06cec656fcc1d475eb86b2a1e7b70b396fb31b5ea7e74ba3d86220e7bdbb50b87c5abd7c4d62d9dd402ef00fd00

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,40 @@
+= Magic encoding
+
+Magic Encoding is a little tool that allows you to quickly 
+add or modify the magic comments that indicate source file 
+encoding for an entire directory structure, please note that 
+this tool only sets the comments, and does not perform any 
+file encoding conversion whatsoever.
+
+If you are looking for a way to convert files to a specific encoding, check out iconv (GNU)
+
+I originally wrote this to get rid of "invalid multibyte char (US-ASCII)" 
+errors when writing strings containing non ascii characters like éöàüèä
+in ruby on rails controllers
+
+== Installation
+
+  gem install magic_encoding
+  
+== Usage
+
+you can call the tool from the console with default parameters like so
+
+  magic_encoding
+
+this will prepend every ".rb" file in the working directory (recursively) with the following line :
+
+  # encoding : utf-8
+
+Notes : 
+- existing magic comments are replaced
+- the rest of the file remains unchanged
+  
+you can pass options to the tool to specify the desired encoding and the path where you want the tool to run, for example :
+
+  magic_encoding Shift-JIS /path/to/ruby/project
+
+For more information on ruby >= 1.9 encoding features, check out http://blog.grayproductions.net/articles/ruby_19s_three_default_encodings
+
+
+

data/bin/magic_encoding

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

data/lib/magic_encoding.rb

@@ -0,0 +1,67 @@
+# -*- encoding : utf-8 -*-
+
+# A simple library to prepend magic comments for encoding to multiple ".rb" files
+
+module AddMagicComment
+
+  # 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)
+
+    # defaults
+    encoding  = options[0] || "utf-8"
+    directory = options[1] || Dir.pwd
+
+    #prefix = "-*- encoding : #{encoding} -*-\n"
+    prefix = "encoding: utf-8\n"
+
+    # TODO : add options for recursivity (and application of the script to a single file)
+
+		extensions = {
+			'rb' => '# {text}',
+			'rake' => '# {text}',
+			'haml' => '-# {text}',
+		}
+
+		count = 0
+		extensions.each do |ext, comment_style|
+			rbfiles = File.join(directory ,'**', '*.'+ext)
+			Dir.glob(rbfiles).each do |filename|
+				file = File.new(filename, "r+")
+
+				lines = file.readlines
+
+				# remove current encoding comment(s)
+        while lines[0].match(/^-?# ?(-\*-)? ?(en)?coding/)
+          lines.shift
+        end
+
+				# set current encoding
+				lines.insert(0,comment_style.sub('{text}', prefix))
+				count += 1
+
+				file.pos = 0
+				file.puts(lines.join)
+				file.close
+			end
+		end
+
+    puts "Magic comments set for #{count} source files"
+  end
+
+end
+
+class String
+
+  def starts_with?(s)
+    self[0..s.length-1] == s
+  end
+
+end
+
+
+
+

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: magic_encoding_just_for_ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- messiahxu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-29 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- ryan@shamu.ch
+executables:
+- magic_encoding
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/magic_encoding
+- lib/magic_encoding.rb
+- README.rdoc
+- CHANGELOG
+- LICENCE
+homepage: http://github.com/messiahxu/magic_encoding
+licenses: []
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Easily add magic comments for encoding on multiple ruby source files
+test_files: []