pretty_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d7bc5567430f8bf0915d758e8614f1ec5607e2e4
+  data.tar.gz: f5ac56662cc80c22e32ee4fb4bc56ade97fba438
+SHA512:
+  metadata.gz: 62ac43aeda22179e1070f1f24b199b8879520210f95518fd6ffb90f8022e76d572f7ff81739bd886c7db99c0557b72598d5783311026f563b7975cac8064db76
+  data.tar.gz: 5c8ebc0d596ee5661b9a68db0304cf74578103bdf914245dc091a9c61696c4ba2708c9df5a8b802e5f7f9ce778517b9339a77d110877d4049b941628814e8290

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at skeang@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pretty_search.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Song Keang
+
+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,70 @@
+# PrettySearch
+
+[![Build Status](https://travis-ci.org/keang/pretty_search.svg?branch=master)](https://travis-ci.org/keang/pretty_search)
+
+- ruby 2.0.0 or newer
+
+Searches given collection in json files and return human readable formats
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pretty_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pretty_search
+
+## Usage
+
+### When you can throw RAM at your problem, and only search once:
+Return all records:
+
+`pretty_search --data users.json name='Raylan Givens'`
+
+Return only first record found:
+
+`pretty_search --first --data users.json name='Raylan Givens'`
+
+Chain queries, searching for records where `shared=false` *AND* `suspended=true`:
+
+`pretty_search --first --data users.json shared=false suspended=true`
+
+### [TODO] When you are poor on RAM or data is big:
+`pretty_search --large-data users.json name='Raylan Givens'`
+
+### [TODO] When you can throw RAM at your problem, and doing many searches:
+`pretty_search --data users.json start`
+
+`pretty_search name='Raylan Givens'`
+
+`pretty_search tags='Foxworth'`
+
+`pretty_search stop`
+
+## 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/keang/pretty_search. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## TODO
+- For large file, read json file in chunk, and search on each chunk in memory
+- A PrettySearch::CsvCollection to read csv (better for chunked searching)
+- A PrettySearch::RedisCollection which load records onto a local redis for a persistent searching session, and using the index_field as redis key
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'pretty_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(__FILE__)

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/exe/pretty_search

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'pretty_search'
+
+options = begin
+            PrettySearch.parse_cli_opts
+          rescue GetoptLong::Error
+            abort
+          end
+if options[:help]
+  puts PrettySearch::HELP_TEXT
+  exit
+end
+
+query = begin
+          PrettySearch::Query.parse(ARGV)
+        rescue => e
+          abort e.message
+        end
+results = begin
+            PrettySearch.run(query, options)
+          rescue => e
+            abort e.message
+          end
+puts results

data/lib/pretty_search.rb

@@ -0,0 +1,26 @@
+require 'yajl/json_gem'
+require 'yajl'
+require 'byebug'
+
+require 'pretty_search/version'
+require 'pretty_search/cli_options'
+require 'pretty_search/query'
+require 'pretty_search/collection'
+require 'pretty_search/document'
+
+module PrettySearch
+  class MissingParameter < StandardError; end
+
+  def self.run(query, data: nil, **options)
+    if data.nil?
+      raise MissingParameter, 'Data file is required, please pass in as --data'
+    end
+    collection = PrettySearch::Collection.load(data, options)
+    found = collection.search(query)
+    if found.empty?
+      'No records found.'
+    else
+      found.join("\n")
+    end
+  end
+end

data/lib/pretty_search/cli_options.rb

@@ -0,0 +1,42 @@
+require 'getoptlong'
+
+module PrettySearch
+  class << self
+    # @return [Hash] like:
+    #   {
+    #     help: [bool],
+    #     data: [string],
+    #   }
+    #
+    def parse_cli_opts
+      abort 'Ruby 2.0.0 or newer is required' unless defined?(GetoptLong)
+      cli_opts = GetoptLong.new(
+        ['--help',  '-h', GetoptLong::NO_ARGUMENT],
+        ['--first', '-f', GetoptLong::NO_ARGUMENT],
+        ['--data',  '-d', GetoptLong::REQUIRED_ARGUMENT]
+      )
+      options = {}
+      cli_opts.each do |option, args|
+        # args is "" for options without an argument
+        options[option[2..-1].to_sym] = args == '' ? true : args
+      end
+      options
+    end
+  end
+
+  HELP_TEXT = <<-EOF.freeze
+pretty_search [OPTION] ... QUERY
+
+Example:
+  pretty_search --data ./fixtures/users.json name='Raylan Givens'
+
+-h, --help:
+   show help
+
+--data FILE, -d FILE:
+   the file to search on
+
+--first, -f:
+   returns when first match is found. Omit this flag to return all matches.
+  EOF
+end

data/lib/pretty_search/collection.rb

@@ -0,0 +1,22 @@
+module PrettySearch
+  # @abstract
+  # PrettySearch::Collection is the abstract class representing
+  # a searchable collection of records.
+  #
+  # Implementations should include:
+  #  - #search(PrettySearch::Query) returning Array<PrettySearch::Document>
+  #
+  # See implementations in lib/pretty_search/collection
+  #
+  class Collection
+    # @return [PrettySearch::Collection, #search]
+    # TODO: return IndexedCollection when multiple searches is supported
+    #
+    def self.load(data_file, options = {})
+      PrettySearch::MemoryCollection.new(data_file, first: options[:first])
+    end
+  end
+end
+
+require 'pretty_search/collection/memory_collection'
+require 'pretty_search/collection/indexed_collection'

data/lib/pretty_search/collection/indexed_collection.rb

@@ -0,0 +1,36 @@
+module PrettySearch
+  # Example extension
+  #
+  # PrettySearch::IndexedCollection is like MemoryCollection, but builds
+  # an index on a given field for faster searching. Ideal for multiple
+  # searches when memory size is not an issue
+  #
+  class IndexedCollection < Collection
+    def initialize(data_file, index_field: nil, first: false)
+      if index_field.nil?
+        raise MissingParameter, 'Field name to be indexed required'
+      end
+      data = Yajl::Parser.parse(File.new(data_file))
+      @index_field = index_field
+      @index = build_index(data, index_field)
+    end
+
+    def search(query)
+      if query[@index_field].nil?
+        raise "indexed field: \"#{@index_field}\" not used in query"
+      end
+      scoped = @index[query[@index_field]]
+      scoped.select { |doc| query.match(doc) }
+    end
+
+    private
+
+    def build_index(data, index_field)
+      Hash.new([]).tap do |index|
+        data.each do |doc|
+          index[doc[index_field]] << doc
+        end
+      end
+    end
+  end
+end

data/lib/pretty_search/collection/memory_collection.rb

@@ -0,0 +1,28 @@
+module PrettySearch
+  # PrettySearch::MemoryCollection parses the given data_file into hash
+  # and keep everything in memory, and iterates through the records naively
+  # from beginning to end when searching
+  #
+  class MemoryCollection < Collection
+    def initialize(data_file, first: false)
+      @data_file = data_file
+      @first = first
+    end
+
+    # @return [Array<PrettySearch::Document>]
+    def search(query)
+      data = Yajl::Parser.parse(File.new(@data_file))
+      if @first
+        found = data.detect { |doc| query.match(doc) }
+        if found
+          Array(PrettySearch::Document.new(found))
+        else
+          []
+        end
+      else
+        data.select { |doc| query.match(doc) }
+            .map { |doc| PrettySearch::Document.new doc }
+      end
+    end
+  end
+end

data/lib/pretty_search/document.rb

@@ -0,0 +1,11 @@
+class PrettySearch::Document
+  attr_reader :data
+
+  def initialize(data)
+    @data = data
+  end
+
+  def to_s
+    JSON.pretty_generate(data)
+  end
+end

data/lib/pretty_search/query.rb

@@ -0,0 +1,70 @@
+# @abstract
+class PrettySearch::Query
+  class InvalidQuery < StandardError; end
+
+  # @return [PrettySearch::Query, #match]
+  #
+  def self.parse(args)
+    parse_simple(args)
+  end
+
+  # @return [PrettySearch::SimpleQuery, #match]
+  #
+  def self.parse_simple(q_strs)
+    parsed_queries = {}
+    q_strs.each do |q_str|
+      matches = PrettySearch::SimpleQuery::SIMPLE_PATTERN.match q_str
+      if matches && matches[1] && matches[2]
+        value = matches[2].strip
+        if value.is_a?(String)
+          value = begin
+                    Integer(value)
+                  rescue
+                    value
+                  end
+        end
+        if value.is_a?(String)
+          value = begin
+                    Float(value)
+                  rescue
+                    value
+                  end
+        end
+        value = true if value == 'true'
+        value = false if value == 'false'
+        parsed_queries[matches[1].strip] = value
+      else
+        raise InvalidQuery, "Cannot understand query: #{q_str}"
+      end
+    end
+
+    PrettySearch::SimpleQuery.new(parsed_queries)
+  end
+end
+
+# Simple query that matches returns matches when all fields
+# matches fully
+class PrettySearch::SimpleQuery < PrettySearch::Query
+  SIMPLE_PATTERN = /\A([\w ]+)=(.+)\z/
+
+  attr_reader :attr
+
+  def initialize(attr)
+    @attr = attr
+  end
+
+  def match(doc)
+    attr.all? do |key, value|
+      doc[key] == value # floats are compared as strings
+    end
+  end
+
+  def [](key)
+    attr[key]
+  end
+
+  # Used in specs
+  def ==(o)
+    attr == o.attr
+  end
+end

data/lib/pretty_search/version.rb

@@ -0,0 +1,3 @@
+module PrettySearch
+  VERSION = '0.1.0'.freeze
+end

data/pretty_search.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pretty_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'pretty_search'
+  spec.version       = PrettySearch::VERSION
+  spec.authors       = ['Song Keang']
+  spec.email         = ['skeang@gmail.com']
+
+  spec.summary       = 'Search your json file'
+  spec.description   = 'Simple command line search'
+  spec.homepage = 'http://rubygems.org/gems/pretty_search'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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_dependency 'yajl-ruby', '~> 1.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'byebug', '~> 9.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.15.0'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: pretty_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Song Keang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: Simple command line search
+email:
+- skeang@gmail.com
+executables:
+- pretty_search
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/pretty_search
+- lib/pretty_search.rb
+- lib/pretty_search/cli_options.rb
+- lib/pretty_search/collection.rb
+- lib/pretty_search/collection/indexed_collection.rb
+- lib/pretty_search/collection/memory_collection.rb
+- lib/pretty_search/document.rb
+- lib/pretty_search/query.rb
+- lib/pretty_search/version.rb
+- pretty_search.gemspec
+homepage: http://rubygems.org/gems/pretty_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.6.10
+signing_key: 
+specification_version: 4
+summary: Search your json file
+test_files: []