truth_serum 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11bd5ca743bdf3ff58d3fe304596c2c829dbaac0
-  data.tar.gz: 537bee9e6d7db49485e6479ce3ea7a0c1fa441a6
+  metadata.gz: 5e8f73535a864ae7b2e8bc1dc32fbe4d8d648cb6
+  data.tar.gz: 63f502f8255d3f70f9bf5f5f995bb8a68dd637a2
 SHA512:
-  metadata.gz: bc5d5395ca20932ca664ad57956601ecb2f47241cb234f09930e5cb5d829c0e79457a9202350c70634d1dd0ec20dbd83445590a6d2d40187ff743367b7ab86c3
-  data.tar.gz: 788837b9491cac7588a831effbd022c44e961ac328fbc37e351f5d5713f19927157cb362a50700cba7df4a0a616b12c06f108dcb2cbb7872c34987b56e3ff3ff
+  metadata.gz: 2818668ee316717a212eb5abe168b17c352a8a48f57f3b24b7977144aaa17b448283185508bb3293eb1f253dd2b9eb4e749faab0eb654996e80162965d408312
+  data.tar.gz: 6cfd62269b1512650028befc0011c169ba605a9c5b4c23121254599edb0c2f097a8e0a57a35a54fe0519a65db6ce10dd66ed66e0b1ab6384878e816446ff8979

data/.rubocop.yml

@@ -0,0 +1,24 @@
+---
+Metrics/AbcSize:
+  Max: 20
+Metrics/ClassLength:
+  Max: 200
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Style/Documentation:
+  Enabled: false
+Style/HashSyntax:
+  Style: no_mixed_keys
+  Exclude:
+    - 'Rakefile'
+Style/EmptyCaseCondition:
+  Enabled: false
+Style/ParallelAssignment:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/WhileUntilModifier:
+  Enabled: false
+

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.4.0

data/Gemfile

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 gemspec

data/Guardfile

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 clearing :on
 
 guard :minitest do

data/Rakefile

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

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "truth_serum"
+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.
@@ -10,5 +11,5 @@ require "truth_serum"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/lib/truth_serum.rb

@@ -1,8 +1,10 @@
-require "truth_serum/version"
-require "truth_serum/result"
-require "truth_serum/token"
-require "truth_serum/lexer"
-require "truth_serum/parser"
+# frozen_string_literal: true
+require 'truth_serum/version'
+require 'truth_serum/result'
+require 'truth_serum/token'
+require 'truth_serum/state_machine'
+require 'truth_serum/lexer'
+require 'truth_serum/parser'
 
 module TruthSerum
   module_function

data/lib/truth_serum/lexer.rb

@@ -1,128 +1,105 @@
+# frozen_string_literal: true
 module TruthSerum
-  class Lexer
-    def initialize(input)
-      @input  = input
-    end
-
-    def reset
-      @index  = 0
-      @tokens = []
-      @buffer = ''
+  class Lexer < StateMachine
+    def lex
+      execute
     end
 
-    def lex
-      reset
-      lex_line
-      @tokens
+    state :start do
+      case peek
+      when nil then :end
+      when ' ' then :lex_space
+      when ':', '+', '-' then :lex_symbol
+      when '"' then :lex_quoted_term
+      else
+        :lex_term
+      end
     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
+    state :lex_space do
+      case peek
+      when ' '
+        append(consume)
+        :lex_space
+      else
+        emit(:space)
+        :start
       end
     end
 
-    def lex_symbol
-      case consume
+    state :lex_symbol do
+      case append(consume)
       when ':' then emit(:colon)
       when '+' then emit(:plus)
       when '-' then emit(:minus)
       else
         raise 'not a symbol'
       end
+      :start
     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
+    state :lex_term do
+      case peek
+      when ' ', ':', nil
+        emit(:term)
+        :start
+      when '"'
+        consume # ignored
+        :lex_term
+      else
+        append(consume)
+        :lex_term
       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)
+    state :lex_quoted_term do
+      raise 'not in quoted term' unless consume == '"'
+      :lex_inside_quoted_term
     end
 
-    def lex_escaped_char
-      raise 'not in escaped char' unless discard == '\\'
-      return @buffer += '\\' if eof?
-
+    state :lex_inside_quoted_term do
       case peek
-      when 'r'
-        discard
-        @buffer += "\r"
-      when 'n'
-        discard
-        @buffer += "\n"
-      else # '\\' '"' and everything else is treated literally
+      when nil
+        emit(:term)
+        :start
+      when '\\'
+        :lex_quoted_char
+      when '"'
         consume
+        emit(:term)
+        :start
+      else
+        append(consume)
+        :lex_inside_quoted_term
       end
     end
 
-    private
-
-    def eof?
-      @index >= @input.length
-    end
+    state :lex_quoted_char do
+      raise 'not in quoted char' unless consume == '\\'
 
-    def chars_left
-      @input.length - @index
-    end
+      case char = consume
+      when 'r'
+        append("\r")
+      when 'n'
+        append("\n")
+      else # '\\' '"' and everything else is passed verbatim
+        append(char)
+      end
 
-    def peek
-      return nil if eof?
-      @input[@index]
+      :lex_inside_quoted_term
     end
 
-    def consume
-      raise 'consume beyond EOF' if eof?
-
-      @buffer += peek
-      discard
-    end
+    private
 
-    def discard
-      @index += 1
-      @input[@index - 1]
+    def append(ch)
+      @buffer ||= ''
+      @buffer += ch
+      ch
     end
 
     def emit(type)
-      return nil if @buffer == ''
-
-      token = Token.new(type, @buffer)
-      @tokens << token
-      @buffer = ''
-      token
+      super(Token.new(type, @buffer))
+      @buffer = nil
     end
   end
 end

data/lib/truth_serum/parser.rb

@@ -1,87 +1,141 @@
+# frozen_string_literal: true
 module TruthSerum
-  class Parser
-    def initialize(tokens)
-      @tokens = tokens
+  class Parser < StateMachine
+    def parse
+      execute
     end
 
-    def reset
-      @result = {
+    # convert result stream to hash
+    def execute
+      @negate = false
+      result = {
         terms:            [],
         negative_terms:   [],
         filters:          {},
-        negative_filters: {},
+        negative_filters: {}
       }
-    end
 
-    def parse
-      reset
-      parse_line
-      @result
-    end
+      stream = super
+      until stream.empty?
+        result = merge_result(result, stream.shift)
+      end
 
-    def parse_line
-      until eof?
-        token = peek
+      result
+    end
 
-        case
-        when token.plus? || token.minus?
-          parse_sign
-        when token.term?
-          parse_term_or_filter
-        else
-          consume # stray colons and spaces
-        end
+    state :start do
+      token = peek
+      case
+      when token.nil?
+        :end
+      when token.plus? || token.minus?
+        :parse_modifier
+      when token.term?
+        :parse_term_or_filter
+      when token.colon? || token.space?
+        consume # ignored
+        :start
       end
     end
 
-    def parse_sign
-      negate = consume.minus? while peek.plus? || peek.minus?
-      if peek.term?
-        parse_term_or_filter(negate: negate)
+    state :parse_modifier do
+      token = consume
+      case
+      when token.plus?
+        @negate = false
+      when token.minus?
+        @negate = true
       else
-        nil
+        raise 'not a modifier'
       end
+      :start
     end
 
-    def parse_term_or_filter(negate: false)
-      term   = ''
-      value  = ''
+    state :parse_term_or_filter do
+      start_token = consume
+      mid_token = peek
+      raise 'not term or filter' unless start_token.term?
+
+      rewind
+      if mid_token.nil? || !mid_token.colon?
+        :parse_term
+      else # mid_token.colon? == true
+        :parse_filter
+      end
+    end
 
-      # first portion of text
-      term = consume.text
-      return emit_term(term, negate: negate) unless peek.colon?
+    state :parse_term do
+      emit_term(consume.text)
+      :start
+    end
 
-      # initial `:` separator
-      consume
+    state :parse_filter do
+      @filter_key = consume.text
+      :parse_filter_separator
+    end
 
-      # the rest becomes value (including successive `:`s '-'s)
-      value += consume.text while peek.colon? || peek.plus? || peek.minus? || peek.term?
+    state :parse_filter_separator do
+      case
+      when peek.nil? # dangling colon at the end, treat key as single term
+        emit_term(@filter_key)
+        @filter_key = nil
+        :start
+      when peek.colon?
+        consume
+        :parse_filter_separator
+      when peek.term?
+        :parse_filter_value
+      else
+        raise 'malformed filter!!!'
+      end
+    end
 
-      emit_filter(term, value, negate: negate)
+    state :parse_filter_value do
+      case
+      when !peek.nil? && (peek.term? || peek.colon?)
+        # consecutive `:` inside value part are treated literally
+        @filter_value ||= ''
+        @filter_value += consume.text
+        :parse_filter_value
+      else
+        emit_filter(@filter_key, @filter_value)
+        @filter_key, @filter_value = nil, nil
+        :start
+      end
     end
 
     private
 
-    def emit_term(term, negate: false)
-      @result[:terms]          << term unless negate
-      @result[:negative_terms] << term if negate
-    end
+    def emit_term(term)
+      type = @negate ? :negative_terms : :terms
+      @negate = false
 
-    def emit_filter(key, value, negate: false)
-      @result[:filters][key]          = value unless negate
-      @result[:negative_filters][key] = value if negate
+      emit(type => [term])
     end
 
-    def eof?
-      peek.is_a?(NilToken)
-    end
+    def emit_filter(key, value)
+      type = @negate ? :negative_filters : :filters
+      @negate = false
 
-    def peek
-      @tokens[0] || NilToken.new
+      emit(type => { key => value })
     end
 
-    def consume
-      @tokens.shift || NilToken.new
+    # simplified 1-deep merge
+    def merge_result(x, y)
+      result = x.merge({})
+      y.each do |key, value|
+        if result.key?(key)
+          if value.is_a?(Hash)
+            result[key] = result[key].merge(value)
+          elsif value.is_a?(Array)
+            result[key] = result[key] + value
+          end
+        else
+          result[key] = value
+        end
+      end
+
+      result
     end
   end
 end

data/lib/truth_serum/result.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module TruthSerum
   class Result
     attr_accessor :terms, :negative_terms, :filters, :negative_filters
@@ -47,8 +48,8 @@ module TruthSerum
 
     def quote_term(term)
       term = term.gsub(/\r/, '\r')
-        .gsub(/\n/, '\n')
-        .gsub(/\\/, '\\\\')
+                 .gsub(/\n/, '\n')
+                 .gsub(/\\/, '\\\\')
 
       "\"#{term}\""
     end

data/lib/truth_serum/state_machine.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+module TruthSerum
+  class StateMachine
+    class << self
+      def states
+        @states ||= {}
+      end
+
+      def state(name, &block)
+        @states ||= {}
+        @states[name] = block
+      end
+    end
+
+    attr_accessor :debug
+
+    def initialize(input)
+      @input    = input
+      @states   = self.class.states
+      @position = 0
+      @result   = []
+    end
+
+    def execute
+      @position = 0
+      @result = []
+
+      state = :start
+      loop do
+        puts "#{self.class.name}: #{state}" if debug
+
+        next_state = instance_eval(&@states[state])
+        case
+        when next_state == :end
+          break
+        when !next_state.is_a?(Symbol)
+          raise "#{state.inspect} did not return the next state."
+        when !@states.key?(next_state)
+          raise "#{state.inspect} refers to undefined #{next_state.inspect} state."
+        end
+
+        state = next_state
+      end
+
+      @result
+    end
+
+    protected
+
+    def peek
+      @input[@position]
+    end
+
+    def consume
+      result = @input[@position]
+      @position += 1
+      result
+    end
+
+    def rewind
+      @position -= 1
+    end
+
+    def eof?
+      @position >= @input.length
+    end
+
+    def emit(value)
+      puts "#{self.class.name}: << #{value.inspect}" if debug
+      @result << value
+    end
+  end
+end

data/lib/truth_serum/token.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module TruthSerum
   class Token
     VALID_TYPES = [
@@ -15,22 +16,10 @@ module TruthSerum
       @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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module TruthSerum
-  VERSION = "0.3.0"
+  VERSION = '0.4.0'
 end

data/truth_serum.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # vim: filetype=ruby
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
@@ -5,23 +6,24 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'truth_serum/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "truth_serum"
+  spec.name          = 'truth_serum'
   spec.version       = TruthSerum::VERSION
-  spec.authors       = ["Chakrit Wichian"]
-  spec.email         = ["chakrit@omise.co"]
+  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.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.bindir        = 'exe'
+  spec.licenses      = ['MIT']
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler",        '~> 1.12'
-  spec.add_development_dependency "rake",           '~> 11.2'
-  spec.add_development_dependency "minitest",       '~> 5.9'
-  spec.add_development_dependency "guard",          '~> 2.14'
-  spec.add_development_dependency "guard-minitest", '~> 2.4'
-  spec.add_development_dependency "pry",            '~> 0.10'
+  spec.add_development_dependency 'bundler',        '~> 1.12'
+  spec.add_development_dependency 'guard',          '~> 2.14'
+  spec.add_development_dependency 'guard-minitest', '~> 2.4'
+  spec.add_development_dependency 'minitest',       '~> 5.9'
+  spec.add_development_dependency 'pry',            '~> 0.10'
+  spec.add_development_dependency 'rake',           '~> 11.2'
+  spec.add_development_dependency 'rubocop',        '~> 0.46'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: truth_serum
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Chakrit Wichian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-08 00:00:00.000000000 Z
+date: 2017-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '2.14'
+- !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: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,47 +67,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.9'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.46'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.46'
 description: 
 email:
 - chakrit@omise.co
@@ -102,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -114,6 +129,7 @@ files:
 - lib/truth_serum/lexer.rb
 - lib/truth_serum/parser.rb
 - lib/truth_serum/result.rb
+- lib/truth_serum/state_machine.rb
 - lib/truth_serum/token.rb
 - lib/truth_serum/version.rb
 - truth_serum.gemspec
@@ -137,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Parser for github-style search.