magic_encoding 0.0.2

data/CHANGELOG

@@ -0,0 +1,3 @@
+## 0.0.1 (August 3, 2010)
+
+Initial Version

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,36 @@
+= 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
+
+== Usage
+
+you can call the tool 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,56 @@
+# -*- 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
+  def self.process(options)
+    
+    # defaults
+    encoding  = options[0] || "utf-8"
+    directory = options[1] || Dir.pwd
+    
+    prefix = "# -*- encoding : #{encoding} -*-\n"
+    
+    # TODO : add options for recursivity (and application of the script to a single file)
+    rbfiles = File.join(directory ,"**", "*.rb")
+    Dir.glob(rbfiles).each do |filename|
+      file = File.new(filename, "r+")
+      
+      lines = file.readlines
+      
+      # remove current encoding comment(s)
+      while lines[0] && (
+            lines[0].starts_with?("# encoding") || 
+            lines[0].starts_with?("# coding") ||
+            lines[0].starts_with?("# -*- encoding"))
+        lines.shift
+      end
+
+      # set current encoding
+      lines.insert(0,prefix)
+      
+      file.pos = 0
+      file.puts(lines.join) 
+      file.close
+    end
+    p "Magic comments set for #{Dir.glob(rbfiles).count} source files"
+  end
+  
+end
+
+class String
+
+  def starts_with?(s)
+    self[0..s.length-1] == s
+  end
+
+end
+
+
+
+

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: magic_encoding
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Manuel Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-03 00:00:00 +02:00
+default_executable: magic_encoding
+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
+has_rdoc: true
+homepage: http://github.com/m-ryan/magic_encoding
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easily add magic comments for encoding on multiple ruby source files
+test_files: []
+