ruby_grep 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jingwen Owen Ou
+
+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.rdoc

@@ -1,44 +1,32 @@
 = ruby_grep
 
-* http://github.com/jingweno/ruby_grep
+Module to search file(s) for lines that match a given pattern. It (will) implements full functionality of the "grep" command in Unix/Linux system with Ruby. Specification goes to http://www.opengroup.org/onlinepubs/9699919799/utilities/grep.html.
 
-== DESCRIPTION:
+== Note on Patches/Pull Requests
 
-Module to search file(s) for lines that match a given pattern.
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
 
-== FEATURES/PROBLEMS:
+== Install
+  $ gem install ruby_grep
 
-* Simulates the "grep" command in Unix/Linux system.
+== Examples
+  require 'ruby_grep'
+  
+  # grep content in a file
+  file = File.open(file_path)
+  file.grep('example', {:recursive => false}) do |path, line|
+    puts "#{path}: #{line}"
+  end
 
-== SYNOPSIS:
+  # grep content by traversing a folder
+  File.grep(folder_path, 'example', {:recursive => true}).each do |match|
+    puts "#{match.path}: #{match.line}" # match is a Struct object with path and line as attributes
+  end
 
-  FIX (code sample of usage)
+== Copyright
 
-== INSTALL:
-
-* sudo gem ruby_grep
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2010 Ruby Grep
-
-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.
+Copyright (c) 2010 Jingwen Owen Ou. See LICENSE for details.

data/Rakefile

@@ -1,29 +1,49 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/ruby_grep'
-
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'ruby_grep' do
-  self.developer 'Jingwen Owen Ou', 'jingweno@gmail.com'
-  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = self.name # TODO this is default value
-  self.test_globs           = ['spec/**/*_spec.rb']
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
-end
-
-github_username= 'jingweno'
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+require 'rubygems'
+require 'rake'
+
+require File.dirname(__FILE__) + '/lib/ruby_grep/version'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruby_grep"
+    gem.summary = %Q{Module to search file(s) for lines that match a given pattern.}
+    gem.description = %Q{Implementing full functionality of the "grep" command in Unix/Linux system with Ruby. Specification goes to http://www.opengroup.org/onlinepubs/9699919799/utilities/grep.html.}
+    gem.email = "jingweno@gmail.com"
+    gem.homepage = "http://github.com/jingweno/ruby_grep"
+    gem.authors = ["Jingwen Owen Ou"]
+    gem.version     = RubyGrep::Version
+
+    gem.add_development_dependency("rspec", ">= 1.2.9")
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ruby_grep #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/ruby_grep/version.rb

@@ -0,0 +1,3 @@
+module RubyGrep
+  Version = '0.0.3'
+end

data/lib/ruby_grep.rb

@@ -1,35 +1,38 @@
-$:.unshift(File.dirname(__FILE__)) unless
-$:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
 require 'find'
 
-module RubyGrep
-  VERSION = '0.0.2'
+MatchLine = Struct.new(:path, :line)
 
+# The mixin provides methods to search file(s) for lines that match a given pattern.
+module RubyGrep
   def self.included(host_class)
     host_class.extend(ClassMethods)
   end
 
   module ClassMethods    
+    # Recursively grep the line(s) of file(s) in the specified path that 
+    # match a given regular expression or a given string of pattern.
+    # An optional block can be passed to manipulate the match line(s). 
+    # Any option is sliently muted for now.
     def grep(path, reg_exp, options={}, &block)
       if reg_exp.kind_of? String
         reg_exp = /#{Regexp.escape(reg_exp)}/
       end
 
-      # If no block is given, print the path and the matched content
-      if !block_given?
-        block = lambda { |p, m| puts "#{p}: #{m}" }
+      matches = []
+      Find.find(path) do |p|
+        IO.readlines(p).grep(reg_exp) do |line|
+          matches << MatchLine.new(p, line.strip)
+        end
       end
 
-      result = Hash.new{ |hash, key| hash[key] = [] }
-      Find.find(path) do |p|
-        IO.readlines(p).grep(reg_exp) do |match|
-          match.strip!
-          block.call(p, match)
-          result[p] << match
+      # If block is given, manipulate the match lines in the block
+      if block_given?
+        matches.each do |match|
+          block.call(match.path, match.line)
         end
-      end    
-      result
+      end
+
+      matches
     end
   end
 end

data/spec/ruby_grep_spec.rb

@@ -1,11 +1,7 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-# Time to add your specs!
-# http://rspec.info/
-describe "Place your specs here" do
-  
-  it "find this spec in spec directory" do
-    # violated "Be sure to write your specs"
+describe "RubyGrep" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
   end
-  
 end

data/spec/spec.opts

@@ -1 +1 @@
---colour
+--color

data/spec/spec_helper.rb

@@ -1,10 +1,9 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  gem 'rspec'
-  require 'spec'
-end
-
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'ruby_grep'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jingwen Owen Ou
@@ -18,66 +18,45 @@ date: 2010-04-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rubyforge
+  name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
+        - 1
         - 2
-        - 0
-        - 4
-        version: 2.0.4
+        - 9
+        version: 1.2.9
   type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  type: :development
-  version_requirements: *id002
-description: Module to search file(s) for lines that match a given pattern.
-email: 
-- jingweno@gmail.com
+description: Implementing full functionality of the "grep" command in Unix/Linux system with Ruby. Specification goes to http://www.opengroup.org/onlinepubs/9699919799/utilities/grep.html.
+email: jingweno@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- LICENSE
+- README.rdoc
 files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
+- .gitignore
+- LICENSE
 - README.rdoc
 - Rakefile
 - lib/ruby_grep.rb
-- script/console
-- script/destroy
-- script/generate
+- lib/ruby_grep/version.rb
 - spec/ruby_grep_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tasks/rspec.rake
 has_rdoc: true
 homepage: http://github.com/jingweno/ruby_grep
 licenses: []
 
-post_install_message: PostInstall.txt
+post_install_message: 
 rdoc_options: 
-- --main
-- README.rdoc
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -96,10 +75,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: ruby_grep
+rubyforge_project: 
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Module to search file(s) for lines that match a given pattern.
 test_files: 
 - spec/ruby_grep_spec.rb
+- spec/spec_helper.rb

data/History.txt

@@ -1,4 +0,0 @@
-=== 0.0.1 2010-04-23
-
-* 1 major enhancement:
-  * Initial release

data/Manifest.txt

@@ -1,13 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-lib/ruby_grep.rb
-script/console
-script/destroy
-script/generate
-spec/ruby_grep_spec.rb
-spec/spec.opts
-spec/spec_helper.rb
-tasks/rspec.rake

data/PostInstall.txt

@@ -1,7 +0,0 @@
-
-For more information on ruby_grep, see http://ruby_grep.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-

data/script/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ruby_grep.rb'}"
-puts "Loading ruby_grep gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/rspec.rake

@@ -1,21 +0,0 @@
-begin
-  require 'spec'
-rescue LoadError
-  require 'rubygems' unless ENV['NO_RUBYGEMS']
-  require 'spec'
-end
-begin
-  require 'spec/rake/spectask'
-rescue LoadError
-  puts <<-EOS
-To use rspec for testing you must install rspec gem:
-    gem install rspec
-EOS
-  exit(0)
-end
-
-desc "Run the specs under spec/models"
-Spec::Rake::SpecTask.new do |t|
-  t.spec_opts = ['--options', "spec/spec.opts"]
-  t.spec_files = FileList['spec/**/*_spec.rb']
-end