gem-grep 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0e202343d2656a46a51114ee7309babaf0df4e1
-  data.tar.gz: 89640c71f9e8219ad7733b01c3ae44812bd745fc
+  metadata.gz: ecbbf3ad67669f6f6513c2673c06c93066015cc9
+  data.tar.gz: e64d0fea2a56e08401360019481aeceea015bdaf
 SHA512:
-  metadata.gz: 7734f187e32b6ace6ba7b2ebe4faa6211f54e0f0a095addf5ec3a21f6c1958d2860798015058eac411122467ab0b937fd6069cf6a2617aa6d91e50fefdcf1449
-  data.tar.gz: 10de66d403f932a5917ad03754aa9dcd113bac681c1ef1108e624938a509fad5e3e4240850c516e571eae0dd6e95f6c0eeb752efa6cb992c97022609ac62871a
+  metadata.gz: f740d838d82bef80f9a2daa40ab582972188458de9ac93e936c4bde5e6b8e4dbdb5cbb056b577c416d06a7fca683a0627598a131377f6b5a6b95df7429882a8a
+  data.tar.gz: 216a491834432db2273ddd6d02beb3c1f4df66429a6d93e2defe8cbe6a5a938677c36b8aba37ccb6007513aec9b5ddbe610a0d976cec742127f54b722b82affd

data/CHANGES.md

@@ -1,5 +1,10 @@
 # CHANGES
 
+## gem-grep 0.7.0 -- 2017-07-29
+
+* Support and recommend ripgrep (rg)
+* Try to show the command more faithfully by quoting and escaping arguments
+
 ## gem-grep 0.6.2 -- 2014-03-24
 
 * Introduce method `grep_command` to make gem-grep more modular and therefore

data/README.md

@@ -17,9 +17,11 @@ Also checkout [gem-eit][].
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby), Rubinius and JRuby.
 * [gem-path](https://github.com/godfat/gem-path)
-* `grep` from shell, or set `GEM_GREP` to `ag` or whatever command you want.
+* `grep` from shell, or set `$GEM_GREP` to `ag` ([The Silver Searcher][ag]),
+  `rg` ([ripgrep][rg]) or other compatible command.
+* [rg][] is recommended.
 
 ## INSTALLATION:
 
@@ -27,15 +29,16 @@ Also checkout [gem-eit][].
 
 ## SYNOPSIS:
 
-Please set either `$GEM_GREP` to the command you want to search sources.
+Please set `$GEM_GREP` to the command you want to search sources.
 By default it would pick `grep` if nothing is set. However we recommend
-[ag][] if you have it installed.
+[rg][] if you have it installed.
 
 Use `--` to pass arguments to `$GEM_GREP`, such as `--color`, `-E`, or `-A`.
 
 Also checkout [gem.fish][] for [fish][] completion.
 
 [ag]: https://github.com/ggreer/the_silver_searcher
+[rg]: https://github.com/BurntSushi/ripgrep
 [gem.fish]: https://github.com/godfat/dev-tool/blob/master/.config/fish/completions/gem.fish
 [fish]: http://fishshell.com/
 
@@ -74,9 +77,9 @@ Also checkout [gem.fish][] for [fish][] completion.
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2013-2014, Lin Jen-Shin (godfat)
+Copyright (c) 2013-2017, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/Rakefile

@@ -1,13 +1,13 @@
 
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__) do |s|
   s.name    = 'gem-grep'
-  s.version = '0.6.2'
+  s.version = '0.7.0'
   s.add_runtime_dependency('gem-path')
 end

data/gem-grep.gemspec

@@ -1,43 +1,43 @@
 # -*- encoding: utf-8 -*-
-# stub: gem-grep 0.6.2 ruby lib
+# stub: gem-grep 0.7.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "gem-grep"
-  s.version = "0.6.2"
+  s.name = "gem-grep".freeze
+  s.version = "0.7.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Lin Jen-Shin (godfat)"]
-  s.date = "2014-03-24"
-  s.description = "grep the gem for a given name or grep the file for a given require path.\n\nAlso checkout [gem-eit][].\n\n[gem-eit]: https://github.com/godfat/gem-eit"
-  s.email = ["godfat (XD) godfat.org"]
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Lin Jen-Shin (godfat)".freeze]
+  s.date = "2017-07-29"
+  s.description = "grep the gem for a given name or grep the file for a given require path.\n\nAlso checkout [gem-eit][].\n\n[gem-eit]: https://github.com/godfat/gem-eit".freeze
+  s.email = ["godfat (XD) godfat.org".freeze]
   s.files = [
-  ".gitignore",
-  ".gitmodules",
-  ".travis.yml",
-  "CHANGES.md",
-  "LICENSE",
-  "README.md",
-  "Rakefile",
-  "gem-grep.gemspec",
-  "lib/rubygems/commands/grep_command.rb",
-  "lib/rubygems_plugin.rb",
-  "task/README.md",
-  "task/gemgem.rb"]
-  s.homepage = "https://github.com/godfat/gem-grep"
-  s.licenses = ["Apache License 2.0"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "grep the gem for a given name or grep the file for a given require path."
+  ".gitignore".freeze,
+  ".gitmodules".freeze,
+  ".travis.yml".freeze,
+  "CHANGES.md".freeze,
+  "LICENSE".freeze,
+  "README.md".freeze,
+  "Rakefile".freeze,
+  "gem-grep.gemspec".freeze,
+  "lib/rubygems/commands/grep_command.rb".freeze,
+  "lib/rubygems_plugin.rb".freeze,
+  "task/README.md".freeze,
+  "task/gemgem.rb".freeze]
+  s.homepage = "https://github.com/godfat/gem-grep".freeze
+  s.licenses = ["Apache-2.0".freeze]
+  s.rubygems_version = "2.6.12".freeze
+  s.summary = "grep the gem for a given name or grep the file for a given require path.".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<gem-path>, [">= 0"])
+      s.add_runtime_dependency(%q<gem-path>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<gem-path>, [">= 0"])
+      s.add_dependency(%q<gem-path>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<gem-path>, [">= 0"])
+    s.add_dependency(%q<gem-path>.freeze, [">= 0"])
   end
 end

data/lib/rubygems/commands/grep_command.rb

@@ -26,7 +26,7 @@ class Gem::Commands::GrepCommand < Gem::Command
   end
 
   def grep_command path_args, grep_args
-    [grep_name, *grep_args, '-nR', capture_path(*path_args)]
+    [grep_name, *grep_args, *grep_default_args, capture_path(*path_args)]
   end
 
   private
@@ -39,11 +39,31 @@ class Gem::Commands::GrepCommand < Gem::Command
   end
 
   def grep_name
-    ENV['GEM_GREP'] || 'grep'
+    @grep_name ||= ENV['GEM_GREP'] || 'grep'
   end
 
-  def exec *args
-    say(args.join(' '))
+  def grep_default_args
+    case grep_name
+    when 'rg'
+      []
+    else
+      ['-nR']
+    end
+  end
+
+  def exec cmd, *args
+    quoted_args = args.map(&method(:quote))
+    say("#{cmd} #{quoted_args.join(' ')}")
     super
   end
+
+  def quote arg
+    escaped = arg.gsub('\\', '\\\\\\').gsub("'", '\'').gsub('"', '\\"')
+
+    if escaped.include?(' ')
+      "'#{escaped}'"
+    else
+      escaped
+    end
+  end
 end

data/task/README.md

@@ -4,16 +4,16 @@
 
 Provided tasks:
 
-    rake clean        # Remove ignored files
+    rake clean        # Trash ignored files
     rake gem:build    # Build gem
     rake gem:install  # Install gem
     rake gem:release  # Release gem
     rake gem:spec     # Generate gemspec
-    rake test         # Run tests in memory
+    rake test         # Run tests
 
 ## REQUIREMENTS:
 
-* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+* Tested with MRI (official CRuby), Rubinius and JRuby.
 
 ## INSTALLATION:
 
@@ -23,13 +23,13 @@ And in Rakefile:
 
 ``` ruby
 begin
-  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+  require "#{__dir__}/task/gemgem"
 rescue LoadError
-  sh 'git submodule update --init'
+  sh 'git submodule update --init --recursive'
   exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
 end
 
-Gemgem.init(dir) do |s|
+Gemgem.init(__dir__, :submodules => %w[your-dep]) do |s|
   s.name    = 'your-gem'
   s.version = '0.1.0'
 end
@@ -37,9 +37,9 @@ end
 
 ## LICENSE:
 
-Apache License 2.0
+Apache License 2.0 (Apache-2.0)
 
-Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+Copyright (c) 2011-2017, Lin Jen-Shin (godfat)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/task/gemgem.rb

@@ -1,7 +1,7 @@
 
 module Gemgem
   class << self
-    attr_accessor :dir, :spec, :spec_create
+    attr_accessor :dir, :spec, :submodules, :spec_create
   end
 
   module_function
@@ -11,12 +11,14 @@ module Gemgem
   def pkg_dir    ; "#{dir}/pkg"                       ; end
   def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
 
-  def init dir, &block
+  def init dir, options={}, &block
     self.dir = dir
-    $LOAD_PATH.unshift("#{dir}/lib")
     ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
     ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.submodules  = options[:submodules] || []
     self.spec_create = block
+
+    $LOAD_PATH.unshift("#{dir}/lib", *submodules_libs)
   end
 
   def create
@@ -26,7 +28,7 @@ module Gemgem
 
       s.description = description.join
       s.summary     = description.first
-      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+      s.license     = license
 
       s.date        = Time.now.strftime('%Y-%m-%d')
       s.files       = gem_files
@@ -34,10 +36,113 @@ module Gemgem
       s.executables = bin_files
     end
     spec_create.call(spec)
-    spec.homepage = "https://github.com/godfat/#{spec.name}"
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
     self.spec = spec
   end
 
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    unless git('status', '--porcelain').empty?
+      puts("\e[35mWorking copy is not clean.\e[0m")
+      exit(3)
+    end
+
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        begin
+          require 'coveralls'
+          SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+        rescue LoadError => e
+          puts "Cannot load coveralls, skip: #{e}"
+        end
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+        submodules_libs.each(&method(:add_filter))
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
   def write
     File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
   end
@@ -57,11 +162,15 @@ module Gemgem
   end
 
   def strip_home_path path
-    path.sub(ENV['HOME'], '~')
+    path.sub(/\A#{Regexp.escape(ENV['HOME'])}\//, '~/')
   end
 
   def strip_cwd_path path
-    path.sub(Dir.pwd, '.')
+    path.sub(/\A#{Regexp.escape(Dir.pwd)}\//, '')
+  end
+
+  def submodules_libs
+    submodules.map{ |path| "#{dir}/#{path}/lib" }
   end
 
   def git *args
@@ -99,6 +208,11 @@ module Gemgem
     @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
   end
 
+  def license
+    readme['LICENSE'].sub(/.+\n\n/, '').lines.first.
+      split(/[()]/).map(&:strip).reject(&:empty?).last
+  end
+
   def all_files
     @all_files ||= fold_files(glob).sort
   end
@@ -119,7 +233,8 @@ module Gemgem
 
   def gem_files
     @gem_files ||= all_files.reject{ |f|
-      f =~ ignored_pattern && !git_files.include?(f)
+      f =~ submodules_pattern ||
+        (f =~ ignored_pattern && !git_files.include?(f))
     }
   end
 
@@ -151,17 +266,20 @@ module Gemgem
                          end
   end
 
+  def submodules_pattern
+    @submodules_pattern ||= if submodules.empty?
+                              /^$/
+                            else
+                              Regexp.new(submodules.map{ |path|
+                                "^#{Regexp.escape(path)}/" }.join('|'))
+                            end
+  end
+
   def expand_patterns pathes
     # http://git-scm.com/docs/gitignore
     pathes.flat_map{ |path|
-      case path
-      when %r{\*}
-        Regexp.escape(path).gsub(/\\\*/, '[^/]*')
-      when %r{^/}
-        "^#{Regexp.escape(path[1..-1])}"
-      else # we didn't implement negative pattern for now
-        Regexp.escape(path)
-      end
+      # we didn't implement negative pattern for now
+      Regexp.escape(path).sub(%r{^/}, '^').gsub(/\\\*/, '[^/]*')
     }
   end
 
@@ -179,86 +297,38 @@ namespace :gem do
 
 desc 'Install gem'
 task :install => [:build] do
-  Gemgem.sh_gem('install', Gemgem.gem_path)
+  Gemgem.gem_install
 end
 
 desc 'Build gem'
 task :build => [:spec] do
-  require 'fileutils'
-  require 'rubygems/package'
-  gem = nil
-  Dir.chdir(Gemgem.dir) do
-    gem = Gem::Package.build(Gem::Specification.load(Gemgem.spec_path))
-    FileUtils.mkdir_p(Gemgem.pkg_dir)
-    FileUtils.mv(gem, Gemgem.pkg_dir) # gem is relative path, but might be ok
-  end
-  puts "\e[35mGem built: \e[33m" \
-       "#{Gemgem.strip_path("#{Gemgem.pkg_dir}/#{gem}")}\e[0m"
+  Gemgem.gem_build
 end
 
 desc 'Generate gemspec'
 task :spec do
-  Gemgem.create
-  Gemgem.write
+  Gemgem.gem_spec
 end
 
 desc 'Release gem'
 task :release => [:spec, :check, :build] do
-  Gemgem.module_eval do
-    sh_git('tag', Gemgem.gem_tag)
-    sh_git('push')
-    sh_git('push', '--tags')
-    sh_gem('push', Gemgem.gem_path)
-  end
+  Gemgem.gem_release
 end
 
 task :check do
-  ver = Gemgem.spec.version.to_s
-
-  if ENV['VERSION'].nil?
-    puts("\e[35mExpected "                                  \
-         "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
-    exit(1)
-
-  elsif ENV['VERSION'] != ver
-    puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
-         "\e[35mbut got\n         "                         \
-         "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
-    exit(2)
-  end
+  Gemgem.gem_check
 end
 
 end # of gem namespace
 
 desc 'Run tests'
 task :test do
-  next if Gemgem.test_files.empty?
-
-  require 'bacon'
-  Bacon.extend(Bacon::TestUnitOutput)
-  Bacon.summary_on_exit
-  Gemgem.test_files.each{ |file| require "#{Gemgem.dir}/#{file[0..-4]}" }
+  Gemgem.test
 end
 
 desc 'Trash ignored files'
 task :clean => ['gem:spec'] do
-  next if Gemgem.ignored_files.empty?
-
-  require 'fileutils'
-  trash = File.expand_path("~/.Trash/#{Gemgem.spec.name}")
-  puts "Move the following files into:" \
-       " \e[35m#{Gemgem.strip_path(trash)}\e[33m"
-
-  Gemgem.ignored_files.each do |file|
-    from = "#{Gemgem.dir}/#{file}"
-    to   = "#{trash}/#{File.dirname(file)}"
-    puts Gemgem.strip_path(from)
-
-    FileUtils.mkdir_p(to)
-    FileUtils.mv(from, to)
-  end
-
-  print "\e[0m"
+  Gemgem.clean
 end
 
 task :default do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gem-grep
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Lin Jen-Shin (godfat)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2017-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem-path
@@ -50,7 +50,7 @@ files:
 - task/gemgem.rb
 homepage: https://github.com/godfat/gem-grep
 licenses:
-- Apache License 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -68,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: grep the gem for a given name or grep the file for a given require path.