truth_serum 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe740d3a98649998bfc874b79cccc33b954ed0ad
+  data.tar.gz: 22759b2db9b456e1072b2abae771568308cef393
+SHA512:
+  metadata.gz: 1caac98110f89c78249c1c7726eeeca0ba2c4cfc5f64bdc56602e00e8baa1300b971e33380d88ceea8729ec22bd14d997373ba6d420ef68643dfb26310b6b674
+  data.tar.gz: 043fe0f877d243500b715e6cde139fc4615cf76d8e0d31d2684b8e92c2545e4fe8faaaa2c4d793b97caa2ded3e007a39168185471f57788cce893a6abbe12464

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+clearing :on
+
+guard :minitest do
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/README.md

@@ -0,0 +1,28 @@
+# TRUTH SERUM
+
+Features
+
+* Parses `keywords` as well as `filters:value` syntax.
+* Handles `"quotes spaces ::: escapes \r\n newlines"`.
+* Has proper lexing and parsing system instead of a regular expression.
+
+# INSTALL
+
+```
+gem install truth_serum
+```
+
+# USAGE
+
+```rb
+require 'truth_serum'
+
+result = TruthSerum.parse("hello world key:value -negate:yes")
+puts result.terms
+puts result.filters
+puts result.negative_filters
+```
+
+# LICENSE
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "truth_serum"
+
+# 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/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/truth_serum/lexer.rb

@@ -0,0 +1,125 @@
+module TruthSerum
+  class Lexer
+    def initialize(input)
+      @input  = input
+      @index  = 0
+      @tokens = []
+      @buffer = ''
+    end
+
+    def lex
+      @tokens = []
+      lex_line
+      @tokens
+    end
+
+    def lex_line
+      until eof?
+        case peek
+        when '"' then lex_quoted_word
+        when ':', '+', '-' then lex_symbol
+        when ' ' then lex_spaces
+        else
+          lex_word
+        end
+      end
+    end
+
+    def lex_symbol
+      case consume
+      when ':' then emit(:colon)
+      when '+' then emit(:plus)
+      when '-' then emit(:minus)
+      else
+        raise 'not a symbol'
+      end
+    end
+
+    def lex_spaces
+      consume while peek == ' '
+      emit(:space)
+    end
+
+    def lex_word
+      until eof?
+        case peek
+        when ' ', ':', '+', '-' then return emit(:term)
+        when '"' then discard
+        else
+          consume
+        end
+      end
+
+      emit(:term)
+    end
+
+    def lex_quoted_word
+      raise 'not in quoted word' unless discard == '"'
+
+      until eof?
+        case peek
+        when '\\' then lex_escaped_char
+        when '"'
+          discard
+          break
+        else
+          consume
+        end
+      end
+
+      emit(:term)
+    end
+
+    def lex_escaped_char
+      raise 'not in escaped char' unless discard == '\\'
+      return @buffer += '\\' if eof?
+
+      case peek
+      when 'r'
+        discard
+        @buffer += "\r"
+      when 'n'
+        discard
+        @buffer += "\n"
+      else # '\\' '"' and everything else is treated literally
+        consume
+      end
+    end
+
+    private
+
+    def eof?
+      @index >= @input.length
+    end
+
+    def chars_left
+      @input.length - @index
+    end
+
+    def peek
+      return nil if eof?
+      @input[@index]
+    end
+
+    def consume
+      raise 'consume beyond EOF' if eof?
+
+      @buffer += peek
+      discard
+    end
+
+    def discard
+      @index += 1
+      @input[@index - 1]
+    end
+
+    def emit(type)
+      return nil if @buffer == ''
+
+      token = Token.new(type, @buffer)
+      @tokens << token
+      @buffer = ''
+      token
+    end
+  end
+end

data/lib/truth_serum/parser.rb

@@ -0,0 +1,85 @@
+module TruthSerum
+  class Parser
+    def initialize(tokens)
+      @tokens = tokens
+    end
+
+    def reset
+      @result = {
+        terms:            [],
+        negative_terms:   [],
+        filters:          {},
+        negative_filters: {},
+      }
+    end
+
+    def parse
+      reset
+      parse_line
+      @result
+    end
+
+    def parse_line
+      until eof?
+        token = peek
+
+        case
+        when token.plus? || token.minus?
+          parse_sign
+        when token.term?
+          parse_term_or_filter
+        else
+          consume # stray colons and spaces
+        end
+      end
+    end
+
+    def parse_sign
+      negate = consume.minus? while peek.plus? || peek.minus?
+      if peek.term?
+        parse_term_or_filter(negate: negate)
+      else
+        nil
+      end
+    end
+
+    def parse_term_or_filter(negate: false)
+      term   = ''
+      value  = ''
+
+      # first portion of text
+      term = consume.text
+      return emit_term(term, negate: negate) unless peek.colon?
+
+      # if we have a filter (detect `:`)
+      consume while peek.colon?
+
+      value = consume.text
+      emit_filter(term, value, negate: negate)
+    end
+
+    private
+
+    def emit_term(term, negate: false)
+      @result[:terms]          << term unless negate
+      @result[:negative_terms] << term if negate
+    end
+
+    def emit_filter(key, value, negate: false)
+      @result[:filters][key]          = value unless negate
+      @result[:negative_filters][key] = value if negate
+    end
+
+    def eof?
+      peek.is_a?(NilToken)
+    end
+
+    def peek
+      @tokens[0] || NilToken.new
+    end
+
+    def consume
+      @tokens.shift || NilToken.new
+    end
+  end
+end

data/lib/truth_serum/result.rb

@@ -0,0 +1,12 @@
+module TruthSerum
+  class Result
+    attr_accessor :terms, :negative_terms, :filters, :negative_filters
+
+    def initialize(terms:, negative_terms:, filters:, negative_filters:)
+      @terms            = terms
+      @negative_terms   = negative_terms
+      @filters          = filters
+      @negative_filters = negative_filters
+    end
+  end
+end

data/lib/truth_serum/token.rb

@@ -0,0 +1,36 @@
+module TruthSerum
+  class Token
+    VALID_TYPES = [
+      :term,
+      :colon,
+      :space,
+      :plus,
+      :minus
+    ].freeze
+
+    attr_accessor :type, :text
+
+    def initialize(type, text)
+      @type = type
+      @text = text
+    end
+
+    def valid?
+      VALID_TYPES.include?(@type) &&
+        !@text.nil? &&
+        !@text.empty?
+    end
+
+    VALID_TYPES.each do |type|
+      define_method "#{type}?" do
+        @type == type
+      end
+    end
+  end
+
+  class NilToken < Token
+    def initialize
+      super(:nil, '')
+    end
+  end
+end

data/lib/truth_serum/version.rb

@@ -0,0 +1,3 @@
+module TruthSerum
+  VERSION = "0.1.1"
+end

data/lib/truth_serum.rb

@@ -0,0 +1,11 @@
+require "truth_serum/version"
+require "truth_serum/result"
+require "truth_serum/token"
+require "truth_serum/lexer"
+require "truth_serum/parser"
+
+module TruthSerum
+  def self.parse(line)
+    Result.new(**Parser.new(Lexer.new(line).lex).parse)
+  end
+end

data/truth_serum.gemspec

@@ -0,0 +1,27 @@
+# vim: filetype=ruby
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'truth_serum/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "truth_serum"
+  spec.version       = TruthSerum::VERSION
+  spec.authors       = ["Chakrit Wichian"]
+  spec.email         = ["chakrit@omise.co"]
+
+  spec.summary       = "Parser for github-style search."
+  spec.homepage      = "https://github.com/chakrit/truth_serum"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.licenses      = ["MIT"]
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler",        '~> 1.12'
+  spec.add_development_dependency "rake",           '~> 11.1'
+  spec.add_development_dependency "minitest",       '~> 5.8'
+  spec.add_development_dependency "guard",          '~> 2.13'
+  spec.add_development_dependency "guard-minitest", '~> 2.4'
+  spec.add_development_dependency "pry",            '~> 0.10'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: truth_serum
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chakrit Wichian
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-09 00:00:00.000000000 Z
+dependencies:
+- !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: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: 
+email:
+- chakrit@omise.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/truth_serum.rb
+- lib/truth_serum/lexer.rb
+- lib/truth_serum/parser.rb
+- lib/truth_serum/result.rb
+- lib/truth_serum/token.rb
+- lib/truth_serum/version.rb
+- truth_serum.gemspec
+homepage: https://github.com/chakrit/truth_serum
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Parser for github-style search.
+test_files: []