rubygrep 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c838b17156364b9342c90840746c64351f30129
-  data.tar.gz: a423599ac57581506b04012e7175a9d789625b56
+  metadata.gz: 8ac2a3d55254f307dc0b56908c0bcd0bc54ade54
+  data.tar.gz: e2e6fa9f6846737e61cf85f152adad84c54c0a21
 SHA512:
-  metadata.gz: 3fc0f69e927d0ed753cc527f1f22a826456d0f58945af3c9399d82c129839c8629760a8e7037c877a8857288622448e5f0bdf7aec58ee1cbc143e92fe9578b28
-  data.tar.gz: 1913cc0bb2554f01c6243531f72893cd4534336a923e9a694a79a646b7d5924ee11aa71ad47eedd59cfb0bb8e69498bc289f03a4d66060e196a7374adacc95d4
+  metadata.gz: b4ab09265f720b24aa175e4913d52b5c71c28bbfba35a39e7a7efd3c0d0dbf8c6363c72a4532b215e20d4d58952f11d671e3d0b070384bb731e6e579f8495316
+  data.tar.gz: 71e1fdee9f2c3cc00feae3b7a5c98a30dc02ef54d654f221d1390dcfb8792731ec8d7f3d3b8f812a3c30a24edb4faa5c4fceec0e1ef5c1d5f5238fa62c6306ab

data/README.md

@@ -1,24 +1,20 @@
 # Rubygrep
 
-TODO: Write a gem description
+Searches for regexp in files and print out strings that match.
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'rubygrep'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install rubygrep
 
 ## Usage
 
-TODO: Write usage instructions here
+Usage: rubygrep [options] expression file1 [file2 file3 ...]
+    -r, --recursive         recursively read directories
+    -i, --ignore-case       Ignore case when matching strings.
+    -v, --invert-selection  Invert the sense of matching, to select non-matching lines.
+    -n, --line-number       Prefix each line of output with the 1-based line number within its input file.
+    -H, --with-filename     Print the file name for each match. This is the default when there is more than one file to search.
+
 
 ## Contributing
 

data/bin/rubygrep

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rubygrep'
+
+options = Rubygrep::RubyGrepOptions.new(ARGV)
+Rubygrep::GrepManager.new(options).run

data/lib/rubygrep.rb

@@ -2,6 +2,7 @@ require 'rubygrep/version'
 require 'rubygrep/grep_manager'
 require 'rubygrep/ruby_grep_options'
 require 'rubygrep/file_reader'
+require 'rubygrep/file_searcher'
 require 'rubygrep/matcher'
 require 'rubygrep/outputter'
 require 'optparse'
@@ -10,7 +11,7 @@ module Rubygrep
 
   def self.grep
     options = RubyGrepOptions.new(ARGV)
-    GrepManager.new(options, options.expression, options.file_names).run
+    GrepManager.new(options).run
   end
 
 end

data/lib/rubygrep/file_reader.rb

@@ -1,11 +1,15 @@
 module Rubygrep
   class FileReader
+
     attr_accessor :file_names, :skip_current_file, :options
 
     def initialize(file_names, options = {})
       @options = options
-      @file_names = []
-      process_with_options(file_names)
+      @file_names = FileSearcher.new(options).search(file_names)
+    end
+
+    def has_several_files?
+      file_names.length > 1
     end
 
     def each_line
@@ -14,6 +18,7 @@ module Rubygrep
         num = 0
         if next_file
           next_file.each_line do |str|
+            str = str.encode("UTF-16be", :invalid=>:replace, :replace=>"").encode('UTF-8') unless str.valid_encoding?
             yield({str: str, path: file_name, str_num: num+=1})
             if skip_current_file
               @skip_current_file = false
@@ -30,32 +35,8 @@ module Rubygrep
 
     private
 
-    def process_with_options(file_names, current_folder = '.')
-      file_names.each do |file_name|
-        if File.directory?(file_name) && options[:recursive]
-          process_with_options(inner_files(file_name), relative_path(file_name, current_folder))
-        elsif File.file?(file_name)
-          @file_names << relative_path(file_name, current_folder)
-        else
-          puts "No such file or directory #{file_name}"
-        end
-      end
-    end
-
-    def inner_files(folder_name)
-      Dir.entries(folder_name).delete_if {|file| file =~ /^\./}
-    end
-
-    def relative_path(file_name, folder)
-        if file_name =~ /^\\|\./
-          file_name
-        else
-          "#{folder}/#{file_name}"
-        end
-    end
-
     def open_file(file_name)
-      File.open(File.expand_path(file_name, Dir.getwd))
+      File.open(file_name)
     rescue Errno::ENOENT
       puts "No such file or directory #{file_name}"
       false

data/lib/rubygrep/file_searcher.rb

@@ -0,0 +1,47 @@
+module Rubygrep
+  class FileSearcher
+    attr_accessor :options, :found_file_names
+
+    def initialize(options = {})
+      @options = options
+      @found_file_names = []
+    end
+
+    def search(file_names)
+      search_with_options(file_names)
+      found_file_names
+    end
+
+    private
+
+    def search_with_options(file_names, current_folder = '.')
+      file_names.each do |file_name|
+        file_path = relative_path(file_name, current_folder)
+        if File.directory?(file_path) && options[:recursive]
+          search_with_options(inner_files(file_path), file_path)
+        elsif text_file?(file_path)
+          found_file_names << file_path
+        elsif !File.exists?(file_path)
+          puts "No such file or directory #{file_path}"
+        end
+      end
+    end
+
+    def inner_files(folder_name)
+      Dir.entries(folder_name).select {|entry| entry != '.' and entry != '..'}
+    end
+
+    def relative_path(file_name, folder)
+      if file_name =~ /^\\/ || folder == '.'
+        file_name
+      else
+        "#{folder}/#{file_name}"
+      end
+    end
+
+    def text_file?(file_name)
+      File.file?(file_name)
+    end
+
+  end
+end

data/lib/rubygrep/grep_manager.rb

@@ -2,17 +2,23 @@ module Rubygrep
   class GrepManager
     attr_reader :file_reader, :matcher, :outputter
 
-    def initialize(options, expression, file_names)
-      @file_reader = FileReader.new(file_names, options.file_reader_options)
-      @matcher = Matcher.new(expression, options.matcher_options)
+    def initialize(options)
+      @file_reader = FileReader.new(options.file_names, options.file_reader_options)
+      options.set_multi_file_mode if @file_reader.has_several_files?
+      @matcher = Matcher.new(options.expression, options.matcher_options)
       @outputter = Outputter.new(options.outputter_options)
     end
 
     def run
       file_reader.each_line do |line_data|
-        match_data = matcher.matches?(line_data)
-        if match_data
-          outputter.out(match_data, line_data)
+        begin
+          match_data = matcher.matches?(line_data)
+          if match_data
+            outputter.out(match_data, line_data)
+          end
+        rescue Exception => e
+          file_reader.next_file!
+          outputter.error(e.message, line_data)
         end
       end
     end

data/lib/rubygrep/outputter.rb

@@ -1,5 +1,8 @@
 module Rubygrep
   class Outputter
+
+    COLORS = {red: 31, magenta: 35}
+
     attr_accessor :options
 
     def initialize(options = {})
@@ -10,16 +13,31 @@ module Rubygrep
       $stdout << format_with_options(match_data, line_data)
     end
 
+    def error(message, line_data)
+      $stdout << "#{colorize(line_data[:path])}: #{message}\n"
+    end
+
     private
 
-    #  puts line_data[:str_num].to_s + ' ' + line_data[:str].insert(match_data.begin(0),'|').insert(match_data.end(0) + 1,'|')
     def format_with_options(match_data, line_data)
-      result = "#{line_data[:str]}"
+      result = colorize_match(match_data, "#{line_data[:str]}")
       if options[:line_number]
-        result = "#{line_data[:str_num]}: #{result}"
+        result = "#{colorize(line_data[:str_num], :magenta)}: #{result}"
+      end
+      if options[:with_filename]
+        result = "#{colorize(line_data[:path], :magenta)}: #{result}"
       end
-      result
+      result.include?("\n") ? result : "#{result}\n"
     end
 
+    def colorize(string, color = :red)
+      "\033[#{COLORS[color]}m#{string}\033[0m"
+    end
+
+    def colorize_match(match_data, string)
+      string.gsub(match_data.regexp) do |match|
+        colorize(match)
+      end
+    end
   end
 end

data/lib/rubygrep/ruby_grep_options.rb

@@ -8,6 +8,10 @@ module Rubygrep
       parse_options(args)
     end
 
+    def set_multi_file_mode
+      outputter_options[:with_filename] = true
+    end
+
     private
 
     def parse_options(args)
@@ -24,7 +28,7 @@ module Rubygrep
 
     def options_parser
       OptionParser.new do |opts|
-        opts.banner = 'Usage: rubygrep.grep [options] expression [file1 file2] ...'
+        opts.banner = 'Usage: rubygrep [options] expression file1 [file2 file3 ...]'
 
         #file_reader_options
         opts.on( '-r', '--recursive', 'recursively read directories' ) do
@@ -48,6 +52,10 @@ module Rubygrep
         opts.on('-n','--line-number','Prefix each line of output with the 1-based line number within its input file.') do
           outputter_options[:line_number] = true
         end
+
+        opts.on('-H','--with-filename', 'Print the file name for each match. This is the default when there is more than one file to search.') do
+          outputter_options[:with_filename] = true
+        end
       end
     end
 

data/lib/rubygrep/version.rb

@@ -1,3 +1,3 @@
 module Rubygrep
-  VERSION = "0.0.2"
+  VERSION = "0.0.4"
 end

data/rubygrep.gemspec

@@ -9,12 +9,12 @@ Gem::Specification.new do |spec|
   spec.authors       = ["andrey"]
   spec.email         = ["om08uhkn@gmail.com"]
   spec.summary       = %q{Analog of unix grep utility.}
-  spec.description   = %q{Globally searches regexp and prints it}
+  spec.description   = %q{Globally searches for in files regexp and prints it}
   spec.homepage      = "https://github.com/fatbeard2/rubygrep"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.executables   = 'rubygrep'
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 

data/spec/file_reader_spec.rb

@@ -1,30 +1,53 @@
 RSpec.describe Rubygrep::FileReader do
 
-  let (:one_file) { 'text1.txt' }
-  let (:several_files) {%w(text1.txt ./text2.txt ../text3.txt ../folder/text4.txt /root/woop/foo/bar/text5.txt)}
+  let (:several_files) {%w(text1.txt ./text2.txt ../text3.txt ../folder/text4.txt /etc/woop/text5.txt)}
+  let (:no_access_files) {%w(/root/smth)}
+
+  before :each do
+    allow(File).to receive(:open) do |file_name|
+      if several_files.include?(file_name)
+        StringIO.new("#{file_name}\n#{file_name}\n#{file_name}\n")
+      elsif  no_access_files.include?(file_name)
+        raise Errno::EACCES
+      else
+        raise Errno::ENOENT
+      end
+    end
 
-  it 'lookup for one file' do
-    allow(File).to receive(:file?).with(one_file).and_return(true)
-    reader = Rubygrep::FileReader.new([one_file])
-    expect(reader.file_names).to eq(%w(text1.txt))
+    allow(File).to receive(:file?) do |file_name|
+      several_files.include?(file_name) ||
+      no_access_files.include?(file_name)
+    end
   end
 
   context 'with several files' do
-    let (:reader) {Rubygrep::FileReader.new(several_files)}
-    before do
-      allow(File).to receive(:file?)  { |file_name| several_files.include?(file_name) }
+    subject(:reader) { Rubygrep::FileReader.new(several_files) }
+
+    it 'should read files line by line' do
+      reader.each_line do |line_data|
+        expect(line_data[:str]).to eq(line_data[:path]+"\n")
+        expect(line_data[:str_num]).to be_between(1,3)
+      end
     end
 
-    it 'should lookup for several files' do
-      expect(reader.file_names).to eq(several_files)
+    it 'should read all lines' do
+      expect { |b| reader.each_line(&b) }.to yield_control.exactly(15).times
     end
 
-    it 'should lookup for several files' do
-      expect { reader.each_line }.to yield_with_args(several_files)
+    it 'should skip files' do
+      reader.each_line do |line_data|
+        reader.next_file!
+        expect(line_data[:str_num]).to eq(1)
+      end
     end
 
+    it 'should respond to has_several_files? message' do
+      expect(reader.has_several_files?).to eq(true)
+    end
   end
 
 
 
+
+
 end

data/spec/file_searcher_spec.rb

@@ -0,0 +1,55 @@
+RSpec.describe Rubygrep::FileSearcher do
+
+  let (:one_file) { 'text1.txt' }
+  let (:several_files) {%w(text1.txt ./text2.txt ../text3.txt ../folder/text4.txt /root/woop/foo/bar/text5.txt)}
+
+  let (:init_dirs) { %w(folder1 /home/user/me) }
+  let (:inner_files_tree) {{
+      'folder1' => %w(inner1 inner2 inner3),
+      'folder1/inner1' => %w(inner1.txt inner2.txt),
+      'folder1/inner2' => %w(inner1.txt inner2.txt),
+      'folder1/inner3' => %w(inner1.txt inner2.txt),
+      '/home/user/me' => %w(1.txt 2.txt 1 2),
+      '/home/user/me/1' => %w(1.txt 2.txt),
+      '/home/user/me/2' => %w(1.txt 2.txt)
+  }}
+  let (:result_files) do
+    inner_files_tree.map do |dir, files|
+      files.collect { |file_name| "#{dir}/#{file_name}" if file_name =~ /\.txt/ }
+    end.flatten.compact
+  end
+
+  def get_entries(dir_name)
+    inner_files_tree[dir_name]
+  end
+
+  let (:searcher) { Rubygrep::FileSearcher.new }
+  let (:recursive_searcher) { Rubygrep::FileSearcher.new({:recursive => true}) }
+
+  it 'lookup for one file' do
+    allow(File).to receive(:file?).with(one_file).and_return(true)
+    expect(searcher.search([one_file])).to eq(%w(text1.txt))
+  end
+
+  context 'with several files' do
+    it 'should lookup for several files' do
+      allow(File).to receive(:file?) { |file_name| several_files.include?(file_name) }
+      expect(searcher.search(several_files)).to eq(several_files)
+    end
+  end
+
+  context 'with -recursive option' do
+    before do
+      allow(File).to receive(:file?) { |file_name| file_name =~ /\.txt/ }
+      allow(File).to receive(:directory?) { |dir_name| !(dir_name =~ /\.txt/) }
+      allow(Dir).to receive(:entries) { |dir_name| get_entries(dir_name) }
+    end
+
+    it 'should recursivly pick up files' do
+      expect(recursive_searcher.search(init_dirs)).to eq(result_files)
+    end
+  end
+
+
+
+end

data/spec/grep_manager_spec.rb

@@ -0,0 +1,48 @@
+describe Rubygrep::GrepManager do
+text2 =  <<-'HERE'
+Lorem Ipsum is simply dummy text of the printing and
+typesetting industry. Lorem Ipsum has been the industry\'s
+standard dummy text ever since the 1500s, when an unknown
+printer took a galley of type and scrambled it to make a type
+specimen book. It has survived not only five centuries, but also
+the leap into electronic typesetting, remaining essentially unchanged.
+It was popularised in the 1960s with the release of Letraset sheets
+containing Lorem Ipsum passages, and more recently with desktop
+publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+HERE
+text1 =  <<-'HERE'
+Contrary to popular belief, Lorem Ipsum is not simply random text
+It has roots in a piece of classical Latin literature from 45 BC, making it over
+2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College
+in Virginia, looked up one of the more obscure Latin words, consectetur, from
+a Lorem Ipsum passage, and going through the cites of the word in classical
+literature, discovered the undoubtable source. Lorem Ipsum comes from
+sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum"
+(The Extremes of Good and Evil) by Cicero, written in 45 BC.
+This book is a treatise on the theory of ethics, very popular
+during the Renaissance. The first line of Lorem Ipsum,
+"Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.
+HERE
+match_output = <<-'HERE'
+text1: 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College
+text2: standard dummy text ever since the 1500s, when an unknown
+text2: It was popularised in the 1960s with the release of Letraset sheets
+HERE
+
+
+  let (:files) { %w(text1 text2)}
+
+  let (:file_contents) {{
+      'text1' => text1,
+      'text2' => text2
+  }}
+  let (:options) { Rubygrep::RubyGrepOptions.new(%w(\d\d\d\d text1 text2)) }
+
+  subject(:grep_manager) { Rubygrep::GrepManager.new(options) }
+
+  it 'should print out matched strings from files' do
+    allow(File).to receive(:file?).and_return(true)
+    allow(File).to receive(:open) { |file_name| (StringIO.new(file_contents[file_name])) }
+    expect { grep_manager.run }.to output(match_output).to_stdout
+  end
+end

data/spec/ruby_grep_options_spec.rb

@@ -15,14 +15,14 @@ RSpec.describe Rubygrep::RubyGrepOptions do
   end
 
   context 'with no additional options' do
-    subject(:options_object) {create_options(%w(exp text text2))}
+    subject(:options_object) {create_options(%w(exp text text1 text2))}
 
     it 'should parse expression' do
       expect(options_object.expression).to eq('exp')
     end
 
     it 'should parse file_names' do
-      expect(options_object.file_names).to eq(%w(text text2))
+      expect(options_object.file_names).to eq(%w(text text1 text2))
     end
 
     it 'should have blank options' do
@@ -30,10 +30,15 @@ RSpec.describe Rubygrep::RubyGrepOptions do
       expect(options_object.matcher_options).to eq({})
       expect(options_object.outputter_options).to eq({})
     end
+
+    it 'should set with_filename option to true' do
+      options_object.set_multi_file_mode
+      expect(options_object.outputter_options).to eq({:with_filename => true})
+    end
   end
 
   context 'with all additional options' do
-    subject(:options_object) {create_options(%w(-r -i -v -n exp text text2))}
+    subject(:options_object) {create_options(%w(-r -i -v -n exp text2))}
     it 'should have parsed options' do
       expect(options_object.file_reader_options).to eq({recursive: true})
       expect(options_object.matcher_options).to eq({ignore_case: true, invert_selection: true})

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygrep/version'
 require 'rubygrep/grep_manager'
 require 'rubygrep/ruby_grep_options'
 require 'rubygrep/file_reader'
+require 'rubygrep/file_searcher'
 require 'rubygrep/matcher'
 require 'rubygrep/outputter'
 require 'optparse'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubygrep
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - andrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,10 +52,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Globally searches regexp and prints it
+description: Globally searches for in files regexp and prints it
 email:
 - om08uhkn@gmail.com
-executables: []
+executables:
+- rubygrep
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,8 +66,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/rubygrep
 - lib/rubygrep.rb
 - lib/rubygrep/file_reader.rb
+- lib/rubygrep/file_searcher.rb
 - lib/rubygrep/grep_manager.rb
 - lib/rubygrep/matcher.rb
 - lib/rubygrep/outputter.rb
@@ -74,6 +77,8 @@ files:
 - lib/rubygrep/version.rb
 - rubygrep.gemspec
 - spec/file_reader_spec.rb
+- spec/file_searcher_spec.rb
+- spec/grep_manager_spec.rb
 - spec/matcher_spec.rb
 - spec/outputter_spec.rb
 - spec/ruby_grep_options_spec.rb
@@ -104,6 +109,8 @@ specification_version: 4
 summary: Analog of unix grep utility.
 test_files:
 - spec/file_reader_spec.rb
+- spec/file_searcher_spec.rb
+- spec/grep_manager_spec.rb
 - spec/matcher_spec.rb
 - spec/outputter_spec.rb
 - spec/ruby_grep_options_spec.rb