ripgrep 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6dffb69b6d7ecbf40ff96f3460f4eba28e2a0ac0996e3511ed632b59de086cb
+  data.tar.gz: de5085e51ba4ebc9663a310e43e8d7d4f08d84ef506b943478ee26d1b0ed8757
+SHA512:
+  metadata.gz: babbc5fa1b3bf7a54393ae11bdaffda0615227cdb807cefe98bcfbc19048a34c632de37ccdc41a39249b17af1d1fb1c05cf6861704be74fb92e3d5691501b5d2
+  data.tar.gz: 363d6a11aef37e65d6cf182b293762958124ccf1b1f2a3c5b9ade2e15cd554f93e4c8e8c5784fc12d881a81bc50eef2f80ffff1f4f1892d32b74294199e65884

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/vendor/bundle
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 motoki-shun
+
+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,39 @@
+**This is under development!**
+
+# ripgrep-ruby
+
+A Ruby wrapper around [ripgrep](https://github.com/BurntSushi/ripgrep)!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ripgrep'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ripgrep
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shuuuuun/ripgrep.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ripgrep"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ripgrep.rb

@@ -0,0 +1,11 @@
+require 'ripgrep/version'
+require 'ripgrep/core'
+require 'ripgrep/client'
+require 'ripgrep/result'
+
+module Ripgrep
+  class Error < StandardError; end
+  class CommandExecutionError < Error; end
+  class NoMatchError < Error; end
+  class ResultError < Error; end
+end

data/lib/ripgrep/client.rb

@@ -0,0 +1,20 @@
+require 'forwardable'
+
+module Ripgrep
+  class Client
+    extend Forwardable
+
+    def_delegators Core, :exec, :version, :help
+
+    def run(&block)
+      instance_eval(&block)
+    end
+
+    private
+
+    def rg(*args)
+      return self if args.empty?
+      Core.exec(*args)
+    end
+  end
+end

data/lib/ripgrep/core.rb

@@ -0,0 +1,30 @@
+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])
+      unless status.exited?
+        # puts "exit status: #{status.exitstatus}"
+        raise Ripgrep::CommandExecutionError, stderr 
+      end
+      Result.new stdout, stderr, exit_status: status.exitstatus
+    end
+
+    def self.version
+      self.exec('--version').to_s
+    end
+
+    def self.help
+      self.exec('--help').to_s
+    end
+  end
+end

data/lib/ripgrep/result.rb

@@ -0,0 +1,41 @@
+module Ripgrep
+  class Result
+    module Status
+      SUCCESS = 0
+      NO_MATCH = 1
+      ERROR = 2
+    end
+
+    attr_reader :raw_result, :raw_error, :exit_status, :matches
+
+    def initialize(result, error = '', exit_status: 0)
+      @raw_result = result
+      @raw_error = error
+      @exit_status = exit_status
+
+      # TODO: skip when not matching result. like a help or version.
+      @matches = result.split("\n").map do |line|
+        # TODO: implement Match class. make more rich and useful interface.
+        file, *body = line.split(':')
+        { file: file, body: body.join(':') }
+      end
+
+      case exit_status
+      when Status::SUCCESS
+      when Status::NO_MATCH
+      when Status::ERROR
+        raise Ripgrep::ResultError, error 
+      else
+        raise Ripgrep::ResultError, error 
+      end
+    end
+
+    def lines
+      @raw_result.to_s.split("\n")
+    end
+
+    def to_s
+      @raw_result.to_s
+    end
+  end
+end

data/lib/ripgrep/version.rb

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

data/ripgrep.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ripgrep/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ripgrep"
+  spec.version       = Ripgrep::VERSION
+  spec.authors       = ["motoki-shun"]
+
+  spec.summary       = "A Ruby wrapper around ripgrep!"
+  spec.description   = "A Ruby wrapper around ripgrep!"
+  spec.homepage      = "https://github.com/shuuuuun/ripgrep-ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ripgrep
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- motoki-shun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A Ruby wrapper around ripgrep!
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ripgrep.rb
+- lib/ripgrep/client.rb
+- lib/ripgrep/core.rb
+- lib/ripgrep/result.rb
+- lib/ripgrep/version.rb
+- ripgrep.gemspec
+homepage: https://github.com/shuuuuun/ripgrep-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A Ruby wrapper around ripgrep!
+test_files: []