bad_encodings-ruby19 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/Rakefile

@@ -0,0 +1,14 @@
+require 'rake/testtask'
+require 'find'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test ActiveScaffold.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+Dir['tasks/**/*.rake'].each { |t| load t }

data/VERSION.yml

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

data/bad_encodings-ruby19.gemspec

@@ -0,0 +1,66 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bad_encodings-ruby19}
+  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-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.md"
+  ]
+  s.files = [
+    "README.md",
+     "Rakefile",
+     "VERSION.yml",
+     "bad_encodings-ruby19.gemspec",
+     "bin/find_bad_encodings",
+     "lib/bad_encodings.rb",
+     "lib/bad_encodings/tasks.rb",
+     "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",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/adamsalter/bad_encodings-ruby19}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.}
+  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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<optiflag>, ["~> 0.6.5"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<optiflag>, ["~> 0.6.5"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<optiflag>, ["~> 0.6.5"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end

data/bin/find_bad_encodings

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'bad_encodings'
+
+if ARGV[0] && File.exists?(ARGV[0])
+  dir = ARGV[0]
+else
+  raise ArgumentError, "must supply a directory"
+end
+
+raise ArgumentError, "Requires Ruby 1.9" unless RUBY_VERSION > '1.9'
+dir = File.expand_path(dir)
+bad_lines = BadEncodings.find_lines_in_path(dir)
+unless bad_lines.empty?
+  puts 'The following bad encodings were found:'
+  bad_lines.each do |line|
+    puts "[%s:%d]" % [line[0].sub(dir,ARGV[0]), line[1]]
+  end
+else
+  puts 'No bad encodings found'
+end

data/lib/bad_encodings.rb

@@ -0,0 +1,68 @@
+require 'find'
+
+class BadEncodings
+  class << self
+    def find_lines_in_path(dir, includes = nil, dir_excludes = nil)
+      includes ||= /(\.rb|\.rake|\.haml|\.sass|\.erb)$/
+      files = []
+      Find.find(dir) do |path|
+        if FileTest.directory?(path)
+          if !dir_excludes.nil? && path =~ dir_excludes
+            Find.prune       # Don't look any further into this directory.
+          else
+            next
+          end
+        elsif path =~ includes
+          files << path
+        end
+      end
+      find_lines_in_files(files.reverse)
+    end
+    
+    def find_lines_in_files(files)
+      bad_lines = []
+      files.each do |file|
+        bad_lines += find_lines_in_file(file)
+      end
+      bad_lines
+    end
+    
+    def find_lines_in_file(file)
+      bad_lines = []
+      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
+      bad_lines
+    end
+    
+    def get_rb_file_encoding(file_path)
+      file = File.open(file_path, 'r:US-ASCII')
+      begin
+        file.each_line do |line|
+          if (file.lineno == 1 || file.lineno == 2) && line =~ /^#.*coding:\s([\w-]+)/
+            return $1
+          elsif file.lineno > 2
+            return 'US-ASCII'
+          end
+        end
+        return 'US-ASCII'
+      rescue ArgumentError
+        # rescue invalid byte sequence on first line of file
+        return 'US-ASCII'
+      ensure
+        file.close
+      end
+    end
+    
+  end
+end

data/lib/bad_encodings/tasks.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+require 'bad_encodings'
+
+desc "find all bad encodïngs in app"
+task 'find_bad_encodings' => :environment do
+  raise ArgumentError, "Requires Ruby 1.9" unless RUBY_VERSION > '1.9'
+  dir = RAILS_ROOT
+  bad_lines = BadEncodings.find_in_path(dir)
+  unless bad_lines.empty?
+    puts 'The following bad encodings were found:'
+    bad_lines.each do |line|
+      puts "[%s:%d]" % [line[0].sub(dir,'RAILS_ROOT'), line[1]]
+    end
+  else
+    puts 'No bad encodings found'
+  end
+end

data/tasks/gemspec.rake

@@ -0,0 +1,15 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = 'bad_encodings-ruby19'
+    s.executables = ['find_bad_encodings']
+    s.summary = 'Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.'
+    s.email = 'adam@codebright.net'
+    s.homepage = 'http://github.com/adamsalter/bad_encodings-ruby19'
+    s.description = 'Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.'
+    s.authors = ['Adam Salter']
+    s.files = FileList['*', '{bin,lib,test,tasks}/**/*']
+    s.add_dependency 'optiflag', '~> 0.6.5'
+    s.add_development_dependency 'shoulda'
+  end
+end

data/test/bad_encodings/bad1.rb

@@ -0,0 +1,4 @@
+# line1
+# encoding: US-ASCII
+
+puts "my bad encodïïïng - line 4"

data/test/bad_encodings/bad2.rb

@@ -0,0 +1,3 @@
+# shoüld give error
+# should not
+# shöuld

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/ok.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+# shoüld bé fïne

data/test/bad_encodings/ok.yml

@@ -0,0 +1,4 @@
+# shouldn't give error since yaml files are 'OK'
+
+test:
+  tëst: 'here'

data/test/bad_encodings_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class BadEncodingsTest < Test::Unit::TestCase
+  context 'A file with bad encodings' do
+    should 'fail' do
+      path = File.dirname(__FILE__)
+      bad_file = path + '/bad_encodings/bad1.rb'
+      bad_lines = BadEncodings.find_lines_in_file(bad_file)
+      assert_equal bad_lines, [[path+"/bad_encodings/bad1.rb", 4]]
+    end
+  end
+
+  context 'A path with bad encodings' do
+    should 'fail' do
+      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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+# require 'test/unit'
+require 'shoulda'
+require 'bad_encodings'

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: bad_encodings-ruby19
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Adam Salter
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-11 00:00:00 +10:00
+default_executable: find_bad_encodings
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: optiflag
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.
+email: adam@codebright.net
+executables: 
+- find_bad_encodings
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- VERSION.yml
+- bad_encodings-ruby19.gemspec
+- bin/find_bad_encodings
+- lib/bad_encodings.rb
+- lib/bad_encodings/tasks.rb
+- 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
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/adamsalter/bad_encodings-ruby19
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Small gem that tries to make the task of finding bad ruby encodings in your project a little easier.
+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