discover_tabs 0.5 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f2c20999e5198d37a1ebb13f5081eb2fd86f203
-  data.tar.gz: 0334b4fb74dce96269f5ce0b1c3c99a9278379bd
+  metadata.gz: e13fe304b1c8b92808bcd20b17a994774143f4b1
+  data.tar.gz: 1e649395b0c028c1470f383348e7e73c6ef0a669
 SHA512:
-  metadata.gz: ea0b7aeb673d91868f75f2475f1afc5a2c9797bf50c4447ecc3f6eec2ff5d63a54e88700351823288b5785f3112a2923180bcf5ef14e12733432f9f6f80a7eca
-  data.tar.gz: da59df03c9963dc13a94b99fbbbf4a7b8d8cc92f105d7692909d077862c7a777bb8462eda68e3a8830b610112d157b124c75094b4f2e48d598420dbf1a461c62
+  metadata.gz: b673f98cdbf7819267b04701e2174d352209d9ca704bef66e4f92a98090436dcbfca5d2ecd9387bc53f3ba42efa6f957f9e98ba97f5af886a5a6223204135181
+  data.tar.gz: 086de983bfc6e27dbba21af102424313903470c935fbf58a077b9cf042c74d48336a3d568a0db8f9c837300a5913a73d80b8102a3333e3118ddaf3d3699231e9

data/README.md

@@ -1,4 +1,23 @@
 discover_tabs
 =============
 
-Discover which files use tabs
+Discover which files use tabs (and potentially replace them with spaces if you like)
+
+### Usage
+
+After installation, there should be a command line app called "discover_tabs" on your path.
+
+    usage: discover_tabs [options] [filename|directory]
+        -r N                             Replace tabs intending with N spaces
+        -h, --help                       Show this message
+
+It will output all of the files that have indentation with tabs. The -r options will replace them with spaces.
+
+examples:
+
+* discover_tabs *.cpp
+* discover_tabs *.cpp -r4
+
+### Installation
+
+gem discover_tabs

data/discover_tabs.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require File.expand_path('../lib/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name    = 'discover_tabs'
+  gem.version = DiscoverTabs::VERSION
+  gem.date    = Date.today.to_s
+  gem.license = 'MIT'
+  gem.executables = [ "discover_tabs" ]
+
+  gem.summary = "Discover which files are tab indented"
+  gem.description = "Library and Command line for discovering files that contain tab indentation"
+
+  gem.authors  = ['Bas Vodde']
+  gem.email    = 'basv@odd-e.com'
+  gem.homepage = 'https://github.com/basvodde/discover_tabs'
+
+  gem.add_runtime_dependency( 'rake', '~> 0')
+  gem.add_runtime_dependency( 'ptools', '~> 1.1')
+  gem.add_development_dependency('rspec', '~> 2.0', '>= 2.0.0')
+
+  gem.files = `git ls-files -- {.,test,spec,lib,bin}/*`.split("\n")
+end

data/lib/discover_tabs.rb

@@ -1,45 +1,112 @@
 require 'pathname'
 require 'ptools'
+require 'optparse'
 
 module DiscoverTabs
 
-  def self.in_dir(dir, pattern = "*")
-    files_with_tabs = false
-    Dir["#{dir}/**/#{pattern}"].each do |file|
-      begin
-        has_tabs = false
-        unless File.directory?(file) || File.binary?(file)
-          has_tabs = in_file(file)
+  class << self
+
+    def files_with_tab_indenting(full_path)
+      filename = File.basename(full_path)
+      dirname = File.dirname(full_path)
+
+      files_with_tabs = []
+      if File.directory?(full_path)
+        files_with_tabs += files_with_tab_indenting_in_dir(full_path)
+      elsif filename.include?("*")
+        files_with_tabs += files_with_tab_indenting_in_dir(dirname, filename)
+      else
+        files_with_tabs << full_path if file_has_tabs_indenting?(full_path)
+      end
+      files_with_tabs
+    end
+
+    def files_with_tab_indenting_in_dir(dir, pattern = "*")
+      files_with_tabs = []
+      Dir["#{dir}/**/#{pattern}"].each do |file|
+        begin
+          unless File.directory?(file) || File.binary?(file)
+            files_with_tabs << file if file_has_tabs_indenting?(file)
+          end
+        rescue ArgumentError
         end
-      rescue ArgumentError
       end
-      files_with_tabs ||= has_tabs
+      files_with_tabs
     end
-    files_with_tabs
-  end
 
-  def self.in_file(filename)
-    File.readlines(filename).each do |line|
-      if line =~ /^\t+/
-        puts Pathname.new(filename).cleanpath.to_s
-        return true
+    def file_has_tabs_indenting?(filename)
+      File.readlines(filename).each do |line|
+        return true if line =~ /^\t+/
       end
+      false
     end
-    false
-  end
 
-  def self.cmdline_run(argv)
-    full_path = argv[0] || "."
-    filename = File.basename(full_path)
-    dirname = File.dirname(full_path)
+    def parse_argv(argv)
+      options = {}
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "usage: discover_tabs [options] [filename|directory]"
+
+        opts.on("-r N", Integer, "Replace tabs intending with N spaces") do |n|
+          options[:replace_tabs] = n
+        end
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts.to_s
+          exit(0)
+        end
+      end
+      opt_parser.parse!(argv)
+
+      options[:files] = argv
+      options[:files] = ["."] if argv.empty?
+
+
+      options
+    rescue OptionParser::InvalidOption => error
+      puts error.message
+      exit 1
+    end
+
+    def cmdline_run(argv)
+      options = parse_argv(argv)
+
+      files_with_tabs = []
+      options[:files].each do |full_path|
+        files_with_tabs += files_with_tab_indenting(full_path)
+      end
+
+      files_with_tabs.each { |file| puts Pathname.new(file).cleanpath.to_s }
+
+      if options[:replace_tabs]
+        replace_tabs_in_files(files_with_tabs, options[:replace_tabs])
+      end
+
+      files_with_tabs.empty? ? 1 : 0
+    end
+
+    def replace_tabs_in_files(files, amount_of_spaces_per_tab)
+      files.each do |file|
+        content = File.read(file)
+        new_content = replace_tabs_with_spaces(content, amount_of_spaces_per_tab)
+        File.write(file, new_content)
+      end
+    end
 
-    found_tabs = if File.directory?(full_path)
-      in_dir(full_path)
-    elsif filename.include?("*")
-       in_dir(dirname, filename)
-    else
-      in_file(full_path)
+    def replace_tabs_with_spaces(content, amount_of_spaces_per_tab)
+      new_content = ""
+      content.lines.each { |line| new_content += replace_tabs_with_spaces_on_line(line, amount_of_spaces_per_tab)}
+      new_content
+    end
+
+    def replace_tabs_with_spaces_on_line(string, amount_of_spaces_per_tab)
+      new_string = string
+      if string =~ /^(\t+)/
+        replacement_spaces = " " * amount_of_spaces_per_tab * $1.size
+        new_string = string.gsub(/^#{$1}/, replacement_spaces)
+      end
+      new_string
     end
-    found_tabs ? 0 : 1
   end
 end
+

data/lib/version.rb

@@ -1,4 +1,4 @@
 
 module DiscoverTabs
-  VERSION = "0.5"
+  VERSION = "0.7"
 end

data/spec/discover_tabs_spec.rb

@@ -2,67 +2,133 @@ require 'spec_helper.rb'
 
 describe "It can discover tabs" do
 
-  it "Can discover tabs in one file" do
-    DiscoverTabs.should_receive(:puts).with(/file_with_tabs.rb/)
-    DiscoverTabs.in_file(test_data("file_with_tabs.rb")).should== true
-  end
+  context "Discovering files with tab indentation" do
 
-  it "Won't discover tabs in one file without tabs" do
-    DiscoverTabs.should_not_receive(:puts)
-    DiscoverTabs.in_file(test_data("file_without_tabs.rb")).should== false
-  end
+    it "Can discover tabs in one file" do
+      DiscoverTabs.file_has_tabs_indenting?(test_data("file_with_tabs.rb")).should== true
+    end
 
-  it "Won't discover any files with tabs in a directory when there are none" do
-    DiscoverTabs.should_not_receive(:puts)
-    DiscoverTabs.in_dir(test_data("dir_without_tabbled_files")).should== false
-  end
+    it "Won't discover tabs in one file without tabs" do
+      DiscoverTabs.file_has_tabs_indenting?(test_data("file_without_tabs.rb")).should== false
+    end
 
-  it "Won't discover any files with tabs in a directory when there are none" do
-    DiscoverTabs.should_receive(:puts).with(/dir_with_some_tabbed_files\/1.rb/)
-    DiscoverTabs.should_receive(:puts).with(/dir_with_some_tabbed_files\/8\/1.rb/)
-    DiscoverTabs.should_receive(:puts).with(/dir_with_some_tabbed_files\/dir\/4.rb/)
-    DiscoverTabs.in_dir(test_data("dir_with_some_tabbed_files")).should== true
-  end
+    it "Won't discover any files with tabs in a directory when there are none" do
+      DiscoverTabs.files_with_tab_indenting_in_dir(test_data("dir_without_tabbled_files")).should be_empty
+    end
 
-  it "Can deal with the current dir" do
-    DiscoverTabs.should_receive(:puts).at_least(1).times
-    DiscoverTabs.in_dir(".").should== true
-  end
+    it "Won't discover any files with tabs in a directory when there are none" do
+      files_with_tabs = DiscoverTabs.files_with_tab_indenting_in_dir(test_data("dir_with_some_tabbed_files"))
+      files_with_tabs[0].should== test_data("dir_with_some_tabbed_files/1.rb")
+      files_with_tabs[1].should== test_data("dir_with_some_tabbed_files/8/1.rb")
+      files_with_tabs[2].should== test_data("dir_with_some_tabbed_files/dir/4.rb")
+      files_with_tabs.size.should== 3
+    end
 
-  it "Should swallow ArgumentError expections" do
-    DiscoverTabs.stub(:in_file).and_raise(ArgumentError)
-    DiscoverTabs.in_dir(".").should== false
-  end
+    it "Can deal with the current dir" do
+      DiscoverTabs.files_with_tab_indenting_in_dir(".").should_not be_empty
+    end
 
-  it "Makes sure the pathname is clean" do
-    DiscoverTabs.should_receive(:puts).with(/dir_with_some_tabbed_files_and_different_extensions\/tabs.rb/)
-    DiscoverTabs.should_receive(:puts)
-    DiscoverTabs.in_dir(test_data("dir_with_some_tabbed_files_and_different_extensions/")).should== true
-  end
+    it "Should swallow ArgumentError expections" do
+      DiscoverTabs.stub(:file_has_tabs_indenting?).and_raise(ArgumentError)
+      DiscoverTabs.files_with_tab_indenting_in_dir(".").should== []
+    end
 
-  it "will only find the files with a certain extension" do
-    DiscoverTabs.should_receive(:puts).with(/dir_with_some_tabbed_files_and_different_extensions\/tabs.rb/)
-    DiscoverTabs.should_not_receive(:puts).with(/dir_with_some_tabbed_files_and_different_extensions\tabs.cpp/)
-    DiscoverTabs.in_dir(test_data("dir_with_some_tabbed_files_and_different_extensions"), "*.rb").should== true
-  end
+    it "will only find the files with a certain extension" do
+      files_with_tabs = DiscoverTabs.files_with_tab_indenting_in_dir(test_data("dir_with_some_tabbed_files_and_different_extensions"), "*rb")
+      files_with_tabs.size.should== 1
+      files_with_tabs[0].should== test_data("dir_with_some_tabbed_files_and_different_extensions/tabs.rb")
+    end
+
+    it "will discover tabs in a file when a filename it passed (success)" do
+      DiscoverTabs.should_receive(:file_has_tabs_indenting?).with(test_data("file_with_tabs.rb")).and_return(true)
+      DiscoverTabs.files_with_tab_indenting(test_data("file_with_tabs.rb")).should== [test_data("file_with_tabs.rb")]
+    end
 
-  it "will discover tabs in a file when a filename it passed (success)" do
-    DiscoverTabs.should_receive(:in_file).with(test_data("file_with_tabs.rb")).and_return(true)
-    DiscoverTabs.cmdline_run([ test_data("file_with_tabs.rb") ]).should== 0
+    it "will discover tabs in a dir when a directory it passed (failed)" do
+      DiscoverTabs.should_receive(:files_with_tab_indenting_in_dir).with(test_data("dir_with_some_tabbed_files")).and_return([])
+      DiscoverTabs.files_with_tab_indenting(test_data("dir_with_some_tabbed_files")).should== []
+    end
+
+    it "will discover a pattern (based on having an * in the filename) and it passes the pattern (success)" do
+      DiscoverTabs.should_receive(:files_with_tab_indenting_in_dir).with(test_data("dir_with_some_tabbed_files"), "*").and_return(["file"])
+      DiscoverTabs.files_with_tab_indenting(test_data("dir_with_some_tabbed_files/*")).should== ["file"]
+    end
   end
 
-  it "will discover tabs in a dir when a directory it passed (failed)" do
-    DiscoverTabs.should_receive(:in_dir).with(test_data("dir_with_some_tabbed_files")).and_return(false)
-    DiscoverTabs.cmdline_run([ test_data("dir_with_some_tabbed_files") ]).should== 1
+  context "tab replacement" do
+
+    it "will return the same line if there is no tab on the line" do
+      DiscoverTabs.replace_tabs_with_spaces_on_line("string", 4).should== "string"
+    end
+
+    it "will convert one tab at the beginning to spaces" do
+      DiscoverTabs.replace_tabs_with_spaces_on_line("\tstring", 2).should== "  string"
+    end
+
+    it "will convert multiple tabs at the beginning to spaces" do
+      DiscoverTabs.replace_tabs_with_spaces_on_line("\t\t\tstring", 3).should== "         string"
+    end
+
+    it "will not convert tabs that are not at the beginning" do
+      DiscoverTabs.replace_tabs_with_spaces_on_line(" \tstri\tng\t", 3).should== " \tstri\tng\t"
+    end
+
+    it "will replace all tabs in a multi-line file" do
+      DiscoverTabs.replace_tabs_with_spaces("\t\thello\nworld\n\t", 2).should== "    hello\nworld\n  "
+    end
+
+    it "will read and re-write the files which it replaces spaces" do
+      File.should_receive(:read).with("file").and_return("content")
+      DiscoverTabs.should_receive(:replace_tabs_with_spaces).with("content", 3).and_return("new_content")
+      File.should_receive(:write).with("file", "new_content")
+      DiscoverTabs.replace_tabs_in_files(["file"], 3)
+    end
   end
 
-  it "will discover a pattern (based on having an * in the filename) and it passes the pattern (success)" do
-    DiscoverTabs.should_receive(:in_dir).with(test_data("dir_with_some_tabbed_files"), "*").and_return(true)
-    DiscoverTabs.cmdline_run([ test_data("dir_with_some_tabbed_files/*") ]).should== 0
+  context "Parsing parameters" do
+    it "Can print out an error on error" do
+      DiscoverTabs.should_receive(:puts).with("invalid option: --wrong_parameter")
+      DiscoverTabs.should_receive(:exit).with(1)
+      DiscoverTabs.parse_argv(["--wrong_parameter"])
+    end
+
+    it "Should receive the help text on -h" do
+      DiscoverTabs.should_receive(:puts).with("usage: discover_tabs [options] [filename|directory]\n    -r N                             Replace tabs intending with N spaces\n    -h, --help\
+                       Show this message\n")
+      DiscoverTabs.should_receive(:exit).with(0)
+      DiscoverTabs.parse_argv(["-h"])
+    end
+
+    it "Should parse the -r4 and pass it back properly" do
+      DiscoverTabs.parse_argv(["-r4", "file"])[:replace_tabs].should == 4
+    end
+
+    it "Should parse the filename|directory" do
+      DiscoverTabs.parse_argv(["file"])[:files].should == ["file"]
+    end
+
+    it "Should default the filename|directory to current dir" do
+      DiscoverTabs.parse_argv([])[:files].should == ["."]
+    end
+
+    it "Options also set the files" do
+      DiscoverTabs.parse_argv(["-r4"])[:files].should == ["."]
+    end
   end
 
-  it "Defaults to the current dir" do
-    DiscoverTabs.should_receive(:in_dir).with(".").and_return(true)
-    DiscoverTabs.cmdline_run([])
+  context "Command line main entry point" do
+    it "Should print all the file to stdout" do
+      DiscoverTabs.should_receive(:files_with_tab_indenting).with("file").and_return(["file"])
+      DiscoverTabs.should_receive(:files_with_tab_indenting).with("file2").and_return([])
+      DiscoverTabs.should_receive(:puts).with("file")
+      DiscoverTabs.cmdline_run(["file", "file2"]).should== 0
+    end
+
+    it "Makes sure the pathname is clean when printing a file" do
+      DiscoverTabs.should_receive(:files_with_tab_indenting).and_return(["file"])
+      DiscoverTabs.should_receive(:puts)
+      DiscoverTabs.should_receive(:replace_tabs_in_files).with(["file"], 4)
+      DiscoverTabs.cmdline_run(["-r4", "file"]).should== 0
+    end
   end
 end

data/spec/test_data/dir_with_some_tabbed_files/1.rb

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

data/spec/test_data/dir_with_some_tabbed_files/8/1.rb

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

data/spec/test_data/dir_with_some_tabbed_files/dir/4.rb

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

data/spec/test_data/dir_with_some_tabbed_files_and_different_extensions/tabs.cpp

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

data/spec/test_data/dir_with_some_tabbed_files_and_different_extensions/tabs.rb

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

data/spec/test_data/file_with_tabs.rb

@@ -1,6 +1,6 @@
 
 class SomeClass
-	def tabbed method
+    def tabbed method
 
-	end
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: discover_tabs
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.7'
 platform: ruby
 authors:
 - Bas Vodde
@@ -70,6 +70,7 @@ files:
 - README.md
 - Rakefile
 - bin/discover_tabs
+- discover_tabs.gemspec
 - lib/discover_tabs.rb
 - lib/version.rb
 - spec/discover_tabs_spec.rb
@@ -84,6 +85,7 @@ files:
 - spec/test_data/dir_with_some_tabbed_files_and_different_extensions/tabs.rb
 - spec/test_data/dir_without_tabbed_files/3.rb
 - spec/test_data/dir_without_tabbed_files/9.rb
+- spec/test_data/dir_without_tabbed_files/binary_file
 - spec/test_data/dir_without_tabbed_files/file_without_tabs.rb
 - spec/test_data/file_with_tabs.rb
 - spec/test_data/file_without_tabs.rb