magic-comment 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8759d94126074281260c6967480931af6007b40f
+  data.tar.gz: 03d5dcd730d9749aa756ae29902108eae2c09795
+SHA512:
+  metadata.gz: 1dbda8d5034ba96b1b1eef45476fef5462fb688f70a815dbbba96bc740cb8fd8c471dda7db8f45abcf37f4e7d68fb45562f48a3055e00e3e13e6439f52d61be4
+  data.tar.gz: 9fe193e86528cf25620653fe21b81d4745177b3ae10cf52b23c0b89bc58479f6f0eba3c51885b5ff633e661a737a266b697c293e94a780092180bcb0809d8e8f

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/CHANGELOG

@@ -0,0 +1,16 @@
+## 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
+
+## 0.0.3 (December 12, 2014)
+
+Supporting for Multiple paths
+
+## 0.1.0 (December 12, 2014)
+
+Rename to magic_comment

data/LICENCE

@@ -0,0 +1,25 @@
+Copyright (c) 2014 Lohn IMAI
+
+
+ORIGINAL PROGRAM
+https://github.com/m-ryan/magic_encoding
+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.md

@@ -0,0 +1,37 @@
+# Magic Comment
+
+Magic Comment 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-comment
+```
+
+## Usage
+
+you can pass the path to where you want the tool to run.
+
+```
+magic-comment [path1 [path2 ...]]
+```
+
+this will prepend every ".rb", ".rake" and ".haml" file in the working directory (recursively) with the following line :
+
+```
+# coding: utf-8
+```
+
+Notes :
+- existing magic comments are replaced
+- the rest of the file remains unchanged

data/bin/magic-comment

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+# A simple tool to prepend magic comments for encoding to multiple ".rb" files
+
+$: << File.expand_path('../lib', File.dirname(__FILE__))
+
+require 'magic-comment'
+
+MagicComment.process(ARGV)

data/lib/magic-comment.rb

@@ -0,0 +1,62 @@
+# coding: utf-8
+# A simple library to prepend magic comments for encoding to multiple ".rb" files
+require 'pathname'
+
+module MagicComment
+
+  # Options :
+  # - paths
+  def self.process(*paths)
+    # defaults
+    paths.flatten!
+    paths.push Dir.pwd if paths.empty?
+
+    encoding = "coding: utf-8"
+    default_comment = "# {encoding}\n"
+
+    # TODO : add options for recursivity (and application of the script to a single file)
+    extensions = {
+      '.rb' => default_comment,
+      '.rake' => default_comment,
+      '.haml' => "-#{default_comment}",
+    }
+
+    files = []
+    paths.each do |path|
+      path = Pathname.new path
+      if path.file?
+        files.push path
+      elsif path.directory?
+        files += Dir.glob path.join('**', "*{#{extensions.keys.join ','}}")
+      end
+    end
+
+    default_comment.sub! '{encoding}', encoding
+    extensions.each_key do |key|
+      extensions[key].sub! '{encoding}', encoding
+    end
+
+    files.each do |filename|
+      file = File.new(filename, "r+")
+      magic_comment = extensions[ File.extname(file) ] || default_comment
+      lines = file.readlines
+
+      # remove current encoding comment(s)
+      while lines[0].match(/^-?# ?(-\*-)? ?(en)?coding/)
+        lines.shift
+      end
+
+      # set current encoding
+      lines.unshift magic_comment
+
+      body = lines.join
+
+      file.pos = 0
+      file.write body
+      file.truncate(body.bytesize)
+      file.close
+    end
+
+    puts "Magic comments set for #{files.length} source files"
+  end
+end

data/magic-comment.gemspec

@@ -0,0 +1,14 @@
+# coding: utf-8
+Gem::Specification.new do |gem|
+  gem.name          = 'magic-comment'
+  gem.version       = "0.1.1"
+  gem.authors       = ["Lohn IMAI"]
+  gem.email         = ["mail@lohn.me"]
+  gem.homepage      = 'http://github.com/m8x/magic-comment'
+  gem.summary       = 'Easily add magic comments for encoding on multiple ruby source files'
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{|f| File.basename(f) }
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: magic-comment
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Lohn IMAI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-12 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- mail@lohn.me
+executables:
+- magic-comment
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG
+- LICENCE
+- README.md
+- bin/magic-comment
+- lib/magic-comment.rb
+- magic-comment.gemspec
+homepage: http://github.com/m8x/magic-comment
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Easily add magic comments for encoding on multiple ruby source files
+test_files: []