adamsalter-bad_encodings-ruby19 0.1.1 → 0.1.2

data/README.md

@@ -0,0 +1,47 @@
+BadEncodings
+================
+
+Small gem that tries to make the task of finding bad ruby encodings in your project a little easier. e.g. 'find_bad_encodings .'
+
+It basically iterates over the regular 'ruby' files it can find and tries each line for 'valid_encoding' and then returns a list of all lines that failed.
+
+Installation
+=======
+
+Install gem as normal
+
+    gem install adamsalter-bad_encodings-ruby19
+
+
+Usage
+-----
+
+You can either use it as a binary:
+
+    ~/my_unencoded_dir/$ find_bad_encodings .
+    # => various wrongly encoded files.
+    
+or add it as a rake task to your (rails) project:
+
+    # put this in your project Rakefile
+    require 'bad_encodings/tasks'
+    
+    ~/my_unencoded_project/$ rake find_bad_encodings
+
+
+
+Known Bugs
+========
+
+None. (well actually the detection of ruby encoding is pretty simple and probably not 100% accurate, certainly works for everything I've tried it on... patches welcome.)
+
+
+Follow me on:
+-------
+
+>  Twitter: [twitter.com/adamsalter](http://twitter.com/adamsalter)  
+>  Github: [github.com/adamsalter](http://github.com/adamsalter)
+
+Copyright (c) 2009 Adam @ [Codebright.net][cb], released under the MIT license
+
+[cb]:http://codebright.net "http://codebright.net"

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 1
+:patch: 2

data/bad_encodings-ruby19.gemspec

@@ -5,20 +5,20 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bad_encodings-ruby19}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Salter"]
-  s.date = %q{2009-09-10}
+  s.date = %q{2009-09-11}
   s.default_executable = %q{find_bad_encodings}
   s.description = %q{Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.}
   s.email = %q{adam@codebright.net}
   s.executables = ["find_bad_encodings"]
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
-    "README.rdoc",
+    "README.md",
      "Rakefile",
      "VERSION.yml",
      "bad_encodings-ruby19.gemspec",
@@ -28,6 +28,7 @@ Gem::Specification.new do |s|
      "tasks/gemspec.rake",
      "test/bad_encodings/bad1.rb",
      "test/bad_encodings/bad2.rb",
+     "test/bad_encodings/bad3.rb",
      "test/bad_encodings/ok.rb",
      "test/bad_encodings/ok.yml",
      "test/bad_encodings_test.rb",
@@ -41,6 +42,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "test/bad_encodings/bad1.rb",
      "test/bad_encodings/bad2.rb",
+     "test/bad_encodings/bad3.rb",
      "test/bad_encodings/ok.rb",
      "test/bad_encodings_test.rb",
      "test/test_helper.rb"

data/lib/bad_encodings.rb

@@ -16,7 +16,7 @@ class BadEncodings
           files << path
         end
       end
-      find_lines_in_files(files)
+      find_lines_in_files(files.reverse)
     end
     
     def find_lines_in_files(files)
@@ -29,9 +29,16 @@ class BadEncodings
     
     def find_lines_in_file(file)
       bad_lines = []
-      file_encoding = get_rb_file_encoding(file)
-      file = File.open(file, "r:#{file_encoding}")
+      file = File.open(file, "r:US-ASCII")
       file.each_line do |line|
+        begin
+          if (file.lineno == 1 || file.lineno == 2) && line =~ /^#.*coding:\s([\w-]+)/
+            file.set_encoding($1)
+          end
+        rescue ArgumentError
+          # regex match will fail with 'invalid byte sequence in US-ASCII'
+          # if invalid byte sequence on first line of file
+        end
         next if line.valid_encoding?
         bad_lines << [file.path, file.lineno]
       end

data/test/bad_encodings/bad3.rb

@@ -0,0 +1,4 @@
+# bad encoding lïne 1
+# encoding: utf-8
+
+# good encoding lïne 4

data/test/bad_encodings_test.rb

@@ -3,20 +3,19 @@ require File.dirname(__FILE__) + '/test_helper'
 class BadEncodingsTest < Test::Unit::TestCase
   context 'A file with bad encodings' do
     should 'fail' do
-      bad_file = File.dirname(__FILE__) + '/bad_encodings/bad1.rb'
+      path = File.dirname(__FILE__)
+      bad_file = path + '/bad_encodings/bad1.rb'
       bad_lines = BadEncodings.find_lines_in_file(bad_file)
-      assert_equal bad_lines.class, Array
-      assert_equal bad_lines[0][1], 4
+      assert_equal bad_lines, [[path+"/bad_encodings/bad1.rb", 4]]
     end
   end
 
   context 'A path with bad encodings' do
     should 'fail' do
-      bad_lines = BadEncodings.find_lines_in_path(File.dirname(__FILE__))
-      assert_equal bad_lines.class, Array
-      assert_equal bad_lines[0][1], 1
-      assert_equal bad_lines[1][1], 3
-      assert_equal bad_lines[2][1], 4
+      path = File.dirname(__FILE__)
+      bad_lines = BadEncodings.find_lines_in_path(path)
+      puts bad_lines.inspect
+      assert_equal bad_lines, [[path+"/bad_encodings/bad1.rb", 4], [path+"/bad_encodings/bad2.rb", 1], [path+"/bad_encodings/bad2.rb", 3], [path+"/bad_encodings/bad3.rb", 1]]
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: adamsalter-bad_encodings-ruby19
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Adam Salter
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-10 00:00:00 -07:00
+date: 2009-09-11 00:00:00 -07:00
 default_executable: find_bad_encodings
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,9 +39,9 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION.yml
 - bad_encodings-ruby19.gemspec
@@ -51,6 +51,7 @@ files:
 - tasks/gemspec.rake
 - test/bad_encodings/bad1.rb
 - test/bad_encodings/bad2.rb
+- test/bad_encodings/bad3.rb
 - test/bad_encodings/ok.rb
 - test/bad_encodings/ok.yml
 - test/bad_encodings_test.rb
@@ -84,6 +85,7 @@ summary: Small gem that tries to make the task of finding bad ruby encodings in
 test_files: 
 - test/bad_encodings/bad1.rb
 - test/bad_encodings/bad2.rb
+- test/bad_encodings/bad3.rb
 - test/bad_encodings/ok.rb
 - test/bad_encodings_test.rb
 - test/test_helper.rb

data/README.rdoc

@@ -1,5 +0,0 @@
-= BadEncodings
-
-http://github.com/adamsalter/bad_encodings-ruby19/tree/master
-
-Small gem that tries to make the task of finding bad ruby encodings in your project a little easier. 'find_bad_encodings .'