jgorset-search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0aa929e751d2c6d415764016f589d9fb3b2986bd
+  data.tar.gz: df8c02c466dcf224cdbbd1cd1eea3b1f6849221d
+SHA512:
+  metadata.gz: b55fbef49bdd628750cf4015ed07386eb8aeb2c70e635258cb53c2710db5c7b6a50f78c681914498317b156acf95ae35fd09ae09b654d547670001a5df799af9
+  data.tar.gz: 1ddabefb8ec74b4ab0068992d9362ea2a0446ed39f8d59020d2293cc1e1413dbb5e6087db9cc3d09130a5c64dc1880629671460fffcee2b16297beb1903065f7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Johannes Gorset
+
+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,47 @@
+# Search
+
+This gem searches files and offers suggestions to narrow the search.
+
+## Installation
+
+    $ gem install jgorset-search
+
+You'll need Ruby > 2.1.
+
+## Usage
+
+### Find files matching the given string
+
+```sh
+$ search 'foo' --files=spec/fixtures/*.txt
+[100%] texts/just_the_word_foo.txt
+[10%] texts/foo_and_other_words.txt
+```
+
+### Get suggestions for narrowing your search
+
+```sh
+$ suggest 'what is' --files=spec/fixtures/*.txt
+what is the meaning of life?
+what is my ip
+what is pokemon go
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/jgorset/search.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "search"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/search

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'search'
+require 'slop'
+
+begin
+  options = Slop.parse do |o|
+    o.string '-f', '--files', 'A file glob to search'
+    o.integer '-n', '--number', 'A number of results to return', default: 10
+    o.on '-v', '--version' do
+      puts "search #{Search::VERSION}"
+      exit
+    end
+    o.on '-h', '--help' do
+      puts o
+      exit
+    end
+  end
+
+  search = Search::CLI.new options.arguments.first, options
+
+  search.qualities.each do |quality, filename|
+    puts "[#{quality}%] #{filename}"
+  end
+rescue StandardError => error
+  puts error.message
+end

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/bin/suggest

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require 'search'
+require 'slop'
+
+begin
+  options = Slop.parse do |o|
+    o.string '-f', '--files', 'A file glob to search'
+    o.integer '-n', '--number', 'A number of results to return', default: 10
+    o.on '-v', '--version' do
+      puts "suggest #{Search::VERSION}"
+      exit
+    end
+    o.on '-h', '--help' do
+      puts o
+      exit
+    end
+  end
+
+  search = Search::CLI.new options.arguments.first, options
+
+  search.suggestions.each do |suggestion|
+    puts suggestion
+  end
+rescue StandardError => error
+  puts error.message
+end

data/lib/search/cli.rb

@@ -0,0 +1,37 @@
+class Search
+  class CLI
+    attr_reader :search, :glob, :limit
+
+    def initialize(search, options)
+      @search = search
+      @glob = options[:files]
+      @limit = options[:n]
+    end
+
+    def files
+      raise Error, 'You must provide files to search' if glob.nil?
+
+      filenames.map do |filename|
+        File.open(filename)
+      end
+    end
+
+    def filenames
+      Dir.glob(glob)
+    end
+
+    def qualities
+      filenames_with_quality = files.map do |file|
+        [Search.new(search, haystack: file.read).quality, file.path]
+      end
+
+      filenames_with_quality.sort_by(&:first).reverse[0, limit]
+    end
+
+    def suggestions
+      files.map do |file|
+        Search.new(search, haystack: file.read).suggestions
+      end[0, limit]
+    end
+  end
+end

data/lib/search/version.rb

@@ -0,0 +1,3 @@
+class Search
+  VERSION = "0.1.0"
+end

data/lib/search.rb

@@ -0,0 +1,78 @@
+require 'search/version'
+require 'search/cli'
+
+class Search
+  # Initializes a new search.
+  #
+  # search - A String describing the term to search for.
+  # haystack - A String to search.
+  def initialize(search, haystack:)
+    @search = search
+    @haystack = haystack
+  end
+
+  # Get suggestions for narrowing the search.
+  #
+  # Example
+  #
+  #   search = Search.new('what is the meaning of',
+  #     haystack: 'What is the meaning of life? And what is the meaning of lol?'
+  #   )
+  #
+  #   search.suggestions
+  #   # => [
+  #   #   [' life', ' lol']
+  #   # ]
+  #
+  # Returns an Array of Strings that would narrow the search.
+  def suggestions
+    suggestions = []
+
+    @haystack.scan /#{@search}(?<suggestion>\b[^.?!]+\b{1,5})/io do |match|
+      suggestions << match.first
+    end
+
+    suggestions
+  end
+
+  # Get the match quality.
+  #
+  # The quality is determined by how many of the search words the haystack contains.
+  #
+  # Example
+  #
+  #   search = Search.new('one two'
+  #     haystack: 'one two three four'
+  #   )
+  #   search.quality
+  #   # => 50
+  #
+  # Returns an Integer describing the percentage of search words present in the haystack.
+  def quality
+    (search_words_present_in_haystack.count.to_f / search_words.count.to_f * 100).round
+  rescue ZeroDivisionError
+    0
+  end
+
+  private
+
+  def search_words
+    @search_words ||= words_in(@search)
+  end
+
+  def haystack_words
+    @haystack_words ||= words_in(@haystack)
+  end
+
+  def search_words_present_in_haystack
+    search_words.select do |search_word|
+      haystack_words.include? search_word
+    end
+  end
+
+  def words_in(string)
+    string.split(/[^[[:word:]]]+/)
+  end
+
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: jgorset-search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Gorset
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+description: File search
+email:
+- jgorset@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/search/cli.rb
+- lib/search/version.rb
+- lib/search.rb
+- bin/console
+- bin/search
+- bin/setup
+- bin/suggest
+- LICENSE.txt
+- README.md
+homepage: https://github.com/jgorset/search
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: File search
+test_files: []