search_in_file 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in search_in_file.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 bmalets
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# SearchInFile
+
+Search files with phrase by directory path.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'search_in_file'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install search_in_file
+
+## Usage
+
+To search some document with specified phrase in your file system just use:
+
+	SearchInFile.search( directory_path, search_phrase )
+
+P.S:       
+  - Windows:  it'll search phrase in all .doc, .docx, .pdf and .txt files by directory path 
+  - OS_X or Linux: it'll search phrase in all .docx, .pdf and .txt files by directory path
+
+## Contributing
+
+1. Fork it ( http://github.com/bmalets/search_in_file/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/file_parsers/doc_parser.rb

@@ -0,0 +1,23 @@
+require 'win32ole'
+
+class DocParser
+
+  def initialize
+    @content = ''
+  end
+
+  def read_file file_path
+    begin
+      word = WIN32OLE.connect( 'Word.Application' )
+      doc  = word.activedocument
+    rescue
+      word = WIN32OLE.new( 'Word.Application' )
+      doc  = word.documents.open( file_path )
+    end
+    word.visible = false
+    doc.sentences.each{ |x| @content << x.text }
+    doc.close
+    word.quit
+    @content
+  end
+end

data/lib/file_parsers/docx_parser.rb

@@ -0,0 +1,15 @@
+require 'docx'
+
+class DocxParser
+
+  def initialize
+    @content = ''
+  end
+
+  def read_file file_path
+    doc = Docx::Document.open( file_path )
+    doc.paragraphs.each{ |p| @content << p.text }
+    @content
+  end
+
+end

data/lib/file_parsers/pdf_parser.rb

@@ -0,0 +1,18 @@
+require 'pdf/reader'
+
+class PdfParser
+
+  def initialize
+    @content = ''
+  end
+
+  def read_file file_path
+    PDF::Reader.open(file_path) do |reader|
+      reader.pages.each do |page|
+        @content << page.text
+      end
+    end
+    @content
+  end
+
+end

data/lib/file_parsers/txt_parser.rb

@@ -0,0 +1,14 @@
+class TxtParser
+
+  def initialize
+    @content = ''
+  end
+
+  def read_file file_path
+    File.open( file_path ).readlines.each do |line|
+       @content << line
+    end
+    @content
+  end
+
+end

data/lib/search_in_file/version.rb

@@ -0,0 +1,3 @@
+module SearchInFile
+  VERSION = "1.0.0"
+end

data/lib/search_in_file.rb

@@ -0,0 +1,66 @@
+require "search_in_file/version"
+require 'find'
+
+require "file_parsers/txt_parser"
+require "file_parsers/pdf_parser"
+require "file_parsers/doc_parser"
+require "file_parsers/docx_parser"
+
+module SearchInFile
+
+  # search files by phrase
+  def self.search( dir_path, term )
+    results = []
+    each_file_in( dir_path ) do |path|  
+      # read file
+      parser_class    = Object.const_get( "#{File.extname( path )[1..-1].capitalize}Parser" )
+      file_content    = parser_class.new.read_file( path )
+      file_paragraphs = file_content.split(/\tor\n|\n/)
+      # search for phrase
+      paragraphs = []
+      file_paragraphs.each{ |p| paragraphs << p if p.include?(term) }
+      results << {file: path, paragraphs: paragraphs} if !paragraphs.empty?
+    end
+    results
+  end
+
+  def self.content_of file
+    class_name   = "#{extname( file )[1..-1].capitalize}Parser"
+    parser_class = Object.const_get( class_name )
+    file_content = parser_class.new.read_file( file )
+  end
+
+  def self.paragraphs_of file
+    content_of( file ).split(/\tor\n|\n/)
+  end
+
+  def self.find_by_type_in d_path, f_type
+    f_paths = []
+    Find.find( d_path ){ |f| f_paths << f if extname?( f, f_type ) }
+    f_paths
+  end
+
+  def self.find_all_in d_path
+    f_paths = []
+    Find.find( d_path ){ |f| f_paths << f if is_document?( f ) }
+    f_paths
+  end
+
+  def self.each_file_in d_path
+    Find.find( d_path ){ |f| yield( f ) if is_document?( f ) && block_given? }
+  end
+
+  def self.extname file
+    File.extname( file )
+  end
+
+  def self.extname? file, type
+    extname( file ) == type
+  end
+
+  def self.is_document? f_name
+    f_type = extname( f_name )
+    ['.doc', '.docx', '.pdf', '.txt'].include? f_type
+  end    
+
+end

data/search_in_file.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'search_in_file/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "search_in_file"
+  spec.version       = SearchInFile::VERSION
+  spec.authors       = ["bmalets"]
+  spec.email         = ["b.malets@gmail.com"]
+  spec.summary       = %q{Search files with phrase by directory path}
+  spec.description   = %q{Search files with phrase by directory path}
+  spec.homepage      = "https://github.com/bmalets/search_in_file/blob/master/README.md"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pdf-reader", "~> 1.3.3"
+  spec.add_development_dependency "docx", "~> 0.2.03"
+  spec.add_development_dependency 'rspec'
+end

data/spec/fixtures/basic.txt

@@ -0,0 +1,9 @@
+	David Heinemeier Hansson extracted Ruby on Rails from his work on Basecamp, a project management tool by 37signals (now a web application company).[3] 
+
+	Hansson first released Rails as open source in July 2004, but did not share commit rights to the project until February 2005.[4] In August 2006, the framework reached a milestone when Apple announced that it would ship Ruby on Rails with Mac OS X v10.5 "Leopard",[5] which was released in October 2007.
+	Rails version 2.3 was released on March 15, 2009 with major new developments in templates, engines, Rack and nested model forms. Templates enable the developer to generate a skeleton application with custom gems and configurations. Engines give developers the ability to reuse application pieces complete with routes, view paths and models. The Rack web server interface and Metal allow one to write optimized pieces of code that route around ActionController.[6]
+	On December 23, 2008, Merb, another web application framework, was launched, and Ruby on Rails announced it would work with the Merb project to bring "the best ideas of Merb" into Rails 3, ending the "unnecessary duplication" across both communities.[7] Merb was merged with Rails as part of the Rails 3.0 release.[8][9]
+	Rails 3.1 was released on August 31, 2011, featuring Reversible Database Migrations, Asset Pipeline, Streaming, jQuery as default JavaScript library and newly introduced CoffeeScript and Sass into the stack.[10]
+	Rails 3.2 was released on January 20, 2012 with a faster development mode and routing engine (also known as Journey engine), Automatic Query Explain and Tagged Logging.[11] Rails 3.2.x is the last version that supports Ruby 1.8.7.[12] Rails 3.2.12 supports Ruby 2.0[13]
+	Rails 4.0 was released on June 25, 2013, introducing Russian Doll Caching, Turbolinks, Live Streaming as well as making Active Resource, Active Record Observer and other components optional by splitting them as gems.[14]
+	Aardvark Pty. Ltd. Often needs to retrieve documents on its hard drive based on those documents containing words or phrases. It thus needs a system that allows the user to enter the required phrase or word and to then find the document/s containing that phrase and to print them to screen. The type of documents that need to be accessed are

data/spec/fixtures/folder1/basic1.txt

@@ -0,0 +1,11 @@
+	David Heinemeier Hansson extracted Ruby on Rails from his work on Basecamp, a project management tool by 37signals (now a web application company).[3] 
+
+	Hansson first released Rails as open source in July 2004, but did not share commit rights to the project until February 2005.[4] In August 2006, the framework reached a milestone when Apple announced that it would ship Ruby on Rails with Mac OS X v10.5 "Leopard",[5] which was released in October 2007.
+	Rails version 2.3 was released on March 15, 2009 with major new developments in templates, engines, Rack and nested model forms. Templates enable the developer to generate a skeleton application with custom gems and configurations. Engines give developers the ability to reuse application pieces complete with routes, view paths and models. The Rack web server interface and Metal allow one to write optimized pieces of code that route around ActionController.[6]
+	On December 23, 2008, Merb, another web application framework, was launched, and Ruby on Rails announced it would work with the Merb project to bring "the best ideas of Merb" into Rails 3, ending the "unnecessary duplication" across both communities.[7] Merb was merged with Rails as part of the Rails 3.0 release.[8][9]
+	Rails 3.1 was released on August 31, 2011, featuring Reversible Database Migrations, Asset Pipeline, Streaming, jQuery as default JavaScript library and newly introduced CoffeeScript and Sass into the stack.[10]
+	Rails 3.2 was released on January 20, 2012 with a faster development mode and routing engine (also known as Journey engine), Automatic Query Explain and Tagged Logging.[11] Rails 3.2.x is the last version that supports Ruby 1.8.7.[12] Rails 3.2.12 supports Ruby 2.0[13]
+	Rails 4.0 was released on June 25, 2013, introducing Russian Doll Caching, Turbolinks, Live Streaming as well as making Active Resource, Active Record Observer and other components optional by splitting them as gems.[14]
+	Aardvark Pty. Ltd. Often needs to retrieve documents on its hard drive based on those documents containing words or phrases. It thus needs a system that allows the user to enter the required phrase or word and to then find the document/s containing that phrase and to print them to screen. The type of documents that need to be accessed are
+
+	sdf

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'search_in_file'

data/spec/specs/search_engine_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe "File Search System" do
+
+  describe "Search engine tests" do
+
+    10.times do |number|
+      it "Search phrase in directory number #{number}" do
+
+        dir_path  = File.expand_path('../..', __FILE__) + '/fixtures'
+        term      = 'Often needs to retrieve documents on its'
+        results   = SearchInFile.search( dir_path, term )
+
+        results.class == 'Array'
+        results.count == 9
+
+        results.each do |result| 
+          ['.doc', '.docx', '.pdf', '.txt'].include? File.extname(result[:file])
+          File.exist?( result[:file] ).should == true 
+          
+          result[:paragraphs].each{ |paragraph| paragraph.include? term }
+        end
+      end
+    end
+
+  end
+end

data/spec/specs/search_files_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe "Folder Search System" do
+
+  describe "Search in folder tests" do
+
+    10.times do |number|
+      it "Search TXT files test number #{number}" do
+        tmp_path = File.expand_path('../..', __FILE__) + '/fixtures'
+        files = SearchInFile.find_by_type_in( tmp_path, '.txt' )
+        files.each{ |f| File.extname(f) == '.txt' }
+        files.count.should == 2
+      end
+    end
+
+    10.times do |number|
+      it "Search PDF files test number #{number}" do
+        tmp_path = File.expand_path('../..', __FILE__) + '/fixtures'
+        files = SearchInFile.find_by_type_in( tmp_path, '.pdf' )
+        files.each{ |f| File.extname(f) == '.pdf' }
+        files.count.should == 3
+      end
+    end
+
+    10.times do |number|
+      it "Search DOC files test number #{number}" do
+        tmp_path = File.expand_path('../..', __FILE__) + '/fixtures'
+        files = SearchInFile.find_by_type_in( tmp_path, '.doc' )
+        files.each{ |f| File.extname(f) == '.doc' }
+        files.count.should == 3
+      end
+    end
+
+    10.times do |number|
+      it "Search DOCX files test number #{number}" do
+        tmp_path = File.expand_path('../..', __FILE__) + '/fixtures'
+        files = SearchInFile.find_by_type_in( tmp_path, '.docx' )
+        files.each{ |f| File.extname(f) == '.docx' }
+        files.count.should == 2
+      end
+    end       
+
+  end
+end

data/spec/specs/search_phrase_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe "File Search System" do
+
+  describe "Document Parsers Testing" do
+
+    10.times do |number|
+      it "Read TXT files test number #{number}" do
+        tmp_path  = File.expand_path('../..', __FILE__) + '/fixtures/basic.txt'
+        data_read = TxtParser.new.read_file(tmp_path)
+        data_read.include? 'Often needs to retrieve documents on its'
+      end
+    end
+
+    10.times do |number|
+      it "Read DOC files test number #{number}" do
+        tmp_path  = File.expand_path('../..', __FILE__) + '/fixtures/basic.doc'
+        data_read = DocParser.new.read_file(tmp_path)
+        data_read.include? 'Often needs to retrieve documents on its'
+      end
+    end
+
+    10.times do |number|
+      it "Read DOCX files test number #{number}" do
+        tmp_path  = File.expand_path('../..', __FILE__) + '/fixtures/basic.docx'
+        data_read = DocxParser.new.read_file(tmp_path)
+        data_read.include? 'Often needs to retrieve documents on its'
+      end
+    end  
+
+    10.times do |number|
+      it "Read PDF files test number #{number}" do
+        tmp_path  = File.expand_path('../..', __FILE__) + '/fixtures/basic.pdf'
+        data_read = PdfParser.new.read_file(tmp_path)
+        data_read.include? 'Often needs to retrieve documents on its'
+      end
+    end       
+
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: search_in_file
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- bmalets
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pdf-reader
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: docx
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.03
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.2.03
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Search files with phrase by directory path
+email:
+- b.malets@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/file_parsers/doc_parser.rb
+- lib/file_parsers/docx_parser.rb
+- lib/file_parsers/pdf_parser.rb
+- lib/file_parsers/txt_parser.rb
+- lib/search_in_file.rb
+- lib/search_in_file/version.rb
+- search_in_file.gemspec
+- spec/fixtures/basic.doc
+- spec/fixtures/basic.docx
+- spec/fixtures/basic.pdf
+- spec/fixtures/basic.txt
+- spec/fixtures/folder1/basic.docx
+- spec/fixtures/folder1/basic1.pdf
+- spec/fixtures/folder1/basic1.txt
+- spec/fixtures/folder2/basic.doc
+- spec/fixtures/folder2/basic2.pdf
+- spec/fixtures/folder2/folder3/basic.doc
+- spec/fixtures/folder2/folder3/basic.pdf
+- spec/spec_helper.rb
+- spec/specs/search_engine_spec.rb
+- spec/specs/search_files_spec.rb
+- spec/specs/search_phrase_spec.rb
+homepage: https://github.com/bmalets/search_in_file/blob/master/README.md
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23.2
+signing_key: 
+specification_version: 3
+summary: Search files with phrase by directory path
+test_files:
+- spec/fixtures/basic.doc
+- spec/fixtures/basic.docx
+- spec/fixtures/basic.pdf
+- spec/fixtures/basic.txt
+- spec/fixtures/folder1/basic.docx
+- spec/fixtures/folder1/basic1.pdf
+- spec/fixtures/folder1/basic1.txt
+- spec/fixtures/folder2/basic.doc
+- spec/fixtures/folder2/basic2.pdf
+- spec/fixtures/folder2/folder3/basic.doc
+- spec/fixtures/folder2/folder3/basic.pdf
+- spec/spec_helper.rb
+- spec/specs/search_engine_spec.rb
+- spec/specs/search_files_spec.rb
+- spec/specs/search_phrase_spec.rb