bad_encodings-ruby19 0.1.2 → 1.0.0

data/README.md

@@ -10,7 +10,7 @@ Installation
 
 Install gem as normal
 
-    gem install adamsalter-bad_encodings-ruby19
+    gem install bad_encodings-ruby19 --source=http://gemcutter.org
 
 
 Usage

data/VERSION.yml

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

data/bad_encodings-ruby19.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bad_encodings-ruby19}
-  s.version = "0.1.2"
+  s.version = "1.0.0"
 
   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.date = %q{2009-10-02}
   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}
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
     "README.md",
      "Rakefile",
      "VERSION.yml",
+     "bad_encodings-ruby19-1.0.0.gem",
      "bad_encodings-ruby19.gemspec",
      "bin/find_bad_encodings",
      "lib/bad_encodings.rb",
@@ -38,7 +39,7 @@ Gem::Specification.new do |s|
   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.summary = %q{Find bad ruby 1.9 encodings in your project.}
   s.test_files = [
     "test/bad_encodings/bad1.rb",
      "test/bad_encodings/bad2.rb",
@@ -53,14 +54,14 @@ Gem::Specification.new do |s|
     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_runtime_dependency(%q<clip>, [">= 1.0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
     else
-      s.add_dependency(%q<optiflag>, ["~> 0.6.5"])
+      s.add_dependency(%q<clip>, [">= 1.0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
     end
   else
-    s.add_dependency(%q<optiflag>, ["~> 0.6.5"])
+    s.add_dependency(%q<clip>, [">= 1.0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
   end
 end

data/bin/find_bad_encodings

@@ -1,20 +1,33 @@
 #!/usr/bin/env ruby
-require 'fileutils'
+require 'clip'
 require 'bad_encodings'
 
-if ARGV[0] && File.exists?(ARGV[0])
-  dir = ARGV[0]
+options = Clip do |p|
+  p.optional 'e', 'file-extensions', :desc => %Q{Set file extensions to search (comma-separated). E.g. 'rb,yml'. To search all files, just pass a comma ','}, :multi => true, :default => "rb,rake,haml,sass,erb"
+  p.flag 'v', 'verbose', :desc => 'Make it chatty.'
+end
+
+if options.valid? && !options.remainder.empty?
+  ENV['VERBOSE'] = 'true' if options.verbose?
+  paths = []
+  options.remainder.each do |dir|
+    paths << [File.expand_path(dir), dir] if File.exists?(dir)
+  end
 else
-  raise ArgumentError, "must supply a directory"
+  $stderr.puts "find_bad_encodings dir1 [dir2 ...] [options]\n" + options.to_s
+  exit
 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)
+
+bad_lines = []
+paths.each do |path|
+  bad_lines += BadEncodings.find_lines_in_path(path[0], options.file_extensions).map! {|bl| [bl[0].sub(path[0],path[1]), bl[1]] }
+end
 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]]
+    puts "[%s:%d]" % [line[0], line[1]]
   end
 else
   puts 'No bad encodings found'

data/lib/bad_encodings.rb

@@ -2,8 +2,8 @@ require 'find'
 
 class BadEncodings
   class << self
-    def find_lines_in_path(dir, includes = nil, dir_excludes = nil)
-      includes ||= /(\.rb|\.rake|\.haml|\.sass|\.erb)$/
+    def find_lines_in_path(dir, file_extensions = ["rb|rake|haml|sass|erb"], dir_excludes = nil)
+      regex = /#{file_extensions.join('|')}$/
       files = []
       Find.find(dir) do |path|
         if FileTest.directory?(path)
@@ -12,7 +12,7 @@ class BadEncodings
           else
             next
           end
-        elsif path =~ includes
+        elsif path =~ regex
           files << path
         end
       end
@@ -28,6 +28,7 @@ class BadEncodings
     end
     
     def find_lines_in_file(file)
+      puts "#{file}" if ENV['VERBOSE']
       bad_lines = []
       file = File.open(file, "r:US-ASCII")
       file.each_line do |line|
@@ -40,6 +41,7 @@ class BadEncodings
           # if invalid byte sequence on first line of file
         end
         next if line.valid_encoding?
+        puts "Bad encoding found: line #{file.lineno}" if ENV['VERBOSE']
         bad_lines << [file.path, file.lineno]
       end
       bad_lines

data/tasks/gemspec.rake

@@ -3,13 +3,13 @@ begin
   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.summary = 'Find bad ruby 1.9 encodings in your project.'
     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_dependency 'clip', '>= 1.0'
     s.add_development_dependency 'shoulda'
   end
 end

data/test/bad_encodings/ok.yml

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

data/test/bad_encodings_test.rb

@@ -1,5 +1,7 @@
 require File.dirname(__FILE__) + '/test_helper'
 
+# ENV['VERBOSE'] = 'true'
+
 class BadEncodingsTest < Test::Unit::TestCase
   context 'A file with bad encodings' do
     should 'fail' do
@@ -14,8 +16,13 @@ class BadEncodingsTest < Test::Unit::TestCase
     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
+
+    should 'fail with certain file extensions' do
+      path = File.dirname(__FILE__)
+      bad_lines = BadEncodings.find_lines_in_path(path, ['yml'])
+      assert_equal bad_lines, [[path+"/bad_encodings/ok.yml", 4]]
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bad_encodings-ruby19
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors: 
 - Adam Salter
@@ -9,18 +9,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-11 00:00:00 +10:00
+date: 2009-10-02 00:00:00 +10:00
 default_executable: find_bad_encodings
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: optiflag
+  name: clip
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.6.5
+        version: "1.0"
     version: 
 - !ruby/object:Gem::Dependency 
   name: shoulda
@@ -44,6 +44,7 @@ files:
 - README.md
 - Rakefile
 - VERSION.yml
+- bad_encodings-ruby19-1.0.0.gem
 - bad_encodings-ruby19.gemspec
 - bin/find_bad_encodings
 - lib/bad_encodings.rb
@@ -83,7 +84,7 @@ 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.
+summary: Find bad ruby 1.9 encodings in your project.
 test_files: 
 - test/bad_encodings/bad1.rb
 - test/bad_encodings/bad2.rb