ripgrep 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6dffb69b6d7ecbf40ff96f3460f4eba28e2a0ac0996e3511ed632b59de086cb
-  data.tar.gz: de5085e51ba4ebc9663a310e43e8d7d4f08d84ef506b943478ee26d1b0ed8757
+  metadata.gz: cafb81708017c1ce6aaa88f54211574a80d72c871061fa14204198a4132a2431
+  data.tar.gz: 47aeb2330a95c67ec6af3fffd0e80fda58e16708caad5e08303e678af9454110
 SHA512:
-  metadata.gz: babbc5fa1b3bf7a54393ae11bdaffda0615227cdb807cefe98bcfbc19048a34c632de37ccdc41a39249b17af1d1fb1c05cf6861704be74fb92e3d5691501b5d2
-  data.tar.gz: 363d6a11aef37e65d6cf182b293762958124ccf1b1f2a3c5b9ade2e15cd554f93e4c8e8c5784fc12d881a81bc50eef2f80ffff1f4f1892d32b74294199e65884
+  metadata.gz: e075f5ba6d493db81d068696a724e8ddaaac311b22dcb368e86552f43cf77e1a2051f7d55e2215b999d3580b9877406b6f0fde465d82f1d06a4d4dc7b5b78f99
+  data.tar.gz: 76fff37ad3a3e68793356d38702ff3b156e95f1ab3bd80aaf6e040b0622cedc606e4ae5fcb8d6c6977153d7d531ca42b2f02a4fec5331e18a9cf539f9bba40be

data/Gemfile

@@ -1,6 +1,4 @@
 source "https://rubygems.org"
 
-gem 'pry'
-
 # Specify your gem's dependencies in ripgrep.gemspec
 gemspec

data/README.md

@@ -1,5 +1,3 @@
-**This is under development!**
-
 # ripgrep-ruby
 
 A Ruby wrapper around [ripgrep](https://github.com/BurntSushi/ripgrep)!
@@ -22,7 +20,64 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+require 'ripgrep'
+
+rg = Ripgrep::Client.new
+
+### return the version like `rg --version`
+puts rg.version
+# =>
+#    ripgrep 11.0.1
+#    -SIMD -AVX (compiled)
+#    +SIMD +AVX (runtime)
+
+### Search like `rg require lib`
+result = rg.exec 'require', path: 'lib'
+puts result
+# =>
+#    lib/ripgrep.rb:require 'ripgrep/version'
+#    lib/ripgrep.rb:require 'ripgrep/core'
+#    lib/ripgrep.rb:require 'ripgrep/client'
+#    lib/ripgrep.rb:require 'ripgrep/result'
+#    lib/ripgrep/client.rb:require 'forwardable'
+#    lib/ripgrep/core.rb:require 'open3'
+
+puts result.matches
+# =>
+#    {:file=>"lib/ripgrep.rb", :body=>"require 'ripgrep/version'"}
+#    {:file=>"lib/ripgrep.rb", :body=>"require 'ripgrep/core'"}
+#    {:file=>"lib/ripgrep.rb", :body=>"require 'ripgrep/client'"}
+#    {:file=>"lib/ripgrep.rb", :body=>"require 'ripgrep/result'"}
+#    {:file=>"lib/ripgrep/client.rb", :body=>"require 'forwardable'"}
+#    {:file=>"lib/ripgrep/core.rb", :body=>"require 'open3'"}
+
+### Search like `rg --ignore-case ruby ripgrep.gemspec`
+result = rg.exec 'ruby', path: 'ripgrep.gemspec', options: { ignore_case: true }
+puts result
+# =>
+#     spec.summary       = "A Ruby wrapper around ripgrep!"
+#     spec.description   = "A Ruby wrapper around ripgrep!"
+#     spec.homepage      = "https://github.com/shuuuuun/ripgrep-ruby"
+#     # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+
+### You can use `rg` method in run block.
+rg.run do
+  result = rg '--ignore-case', 'ruby'
+  puts result
+end
+
+Ripgrep.run do
+  result = rg '--ignore-case', 'ruby'
+  puts result
+end
+```
+
+## Links
+
+* Original: https://github.com/BurntSushi/ripgrep
+* GitHub: https://github.com/shuuuuun/ripgrep-ruby
+* RubyGems: https://rubygems.org/gems/ripgrep
 
 ## Development
 
@@ -32,7 +87,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/shuuuuun/ripgrep.
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuuuuun/ripgrep-ruby.
 
 ## License
 

data/lib/ripgrep.rb

@@ -8,4 +8,10 @@ module Ripgrep
   class CommandExecutionError < Error; end
   class NoMatchError < Error; end
   class ResultError < Error; end
+
+  class << self
+    def run(&block)
+      Client.new.run(&block)
+    end
+  end
 end

data/lib/ripgrep/client.rb

@@ -4,7 +4,31 @@ module Ripgrep
   class Client
     extend Forwardable
 
-    def_delegators Core, :exec, :version, :help
+    def_delegators Core, :version, :help
+
+    def initialize(verbose: false)
+      @verbose = verbose
+    end
+
+    def exec(*args, opts)
+      unless opts.is_a? Hash
+        args << opts
+        opts = {}
+      end
+      verbose = opts[:verbose].nil? ? @verbose : !!opts[:verbose]
+      cli_options = opts[:options]&.map do |key, val|
+        next unless val
+        val = '' if val.is_a? TrueClass
+        val = val.join if val.is_a? Array
+        key = key.to_s.tr('_', '-')
+        "--#{key} #{val}".strip
+      end&.compact || []
+      puts "cli_options: #{cli_options}" if verbose
+      cli_arguments = cli_options + args
+      cli_arguments << (opts[:path] || '.')
+      puts "cli_arguments: #{cli_arguments}" if verbose
+      Core.exec(*cli_arguments, verbose: verbose)
+    end
 
     def run(&block)
       instance_eval(&block)
@@ -14,7 +38,7 @@ module Ripgrep
 
     def rg(*args)
       return self if args.empty?
-      Core.exec(*args)
+      exec(*args, verbose: @verbose)
     end
   end
 end

data/lib/ripgrep/core.rb

@@ -2,18 +2,10 @@ require 'open3'
 
 module Ripgrep
   class Core
-    def self.exec(*args, opts)
-      unless opts.is_a? Hash
-        args << opts
-        opts = {}
-      end
-      # TODO: support cli options
-      opts = { path: '.' }.merge(opts)
-      # TODO: make debug logger
-      # puts "args: #{args}, opts: #{opts}"
-      stdout, stderr, status = Open3.capture3('rg', *args, opts[:path])
+    def self.exec(*args, verbose: false)
+      stdout, stderr, status = Open3.capture3('rg', *args)
+      puts "exit status: #{status.exitstatus}" if verbose
       unless status.exited?
-        # puts "exit status: #{status.exitstatus}"
         raise Ripgrep::CommandExecutionError, stderr 
       end
       Result.new stdout, stderr, exit_status: status.exitstatus

data/lib/ripgrep/version.rb

@@ -1,3 +1,3 @@
 module Ripgrep
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/ripgrep.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ripgrep
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - motoki-shun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2019-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby wrapper around ripgrep!
 email: 
 executables: []