Contents

# frozen-string-literal: true

require 'delegate'
require 'search_lingo/constants'

module SearchLingo
  ##
  # Single token from a query string. A token consists of a term an an optional
  # modifier. The term may be a word or multiple words contained within double
  # quotes. The modifier is one or more alphanumeric characters. The modifier
  # and term and separated by a colon followed by zero or more whitespace
  # characters.
  #
  # The following are examples of tokens:
  #
  #   Token.new('foo')
  #   Token.new('"foo bar"')
  #   Token.new('foo: bar')
  #   Token.new('foo: "bar baz"')
  class Token < DelegateClass(String)
    ##
    # Pattern for decomposing a token into a modifier and a term.
    STRUCTURE = /\A(?:(#{MODIFIER}):[[:space:]]*)?"?(.+?)"?\z/

    ##
    # Returns the modifier portion of the token. Returns +nil+ if token does
    # not have a modifier.
    #
    #   Token.new('foo: bar').modifier # => 'foo'
    #   Token.new('bar').modifier      # => nil
    def modifier
      self[STRUCTURE, 1]
    end

    alias operator modifier

    ##
    # Returns the term portion of the token. If the term is wrapped in quotes,
    # they are removed.
    #
    #   Token.new('foo: bar').term  # => 'bar'
    #   Token.new('bar').term       # => 'bar'
    #   Token.new('"bar baz"').term # => 'bar baz'
    def term
      self[STRUCTURE, 2]
    end

    ##
    # Returns +true+ if token has a modifier and +false+ otherwise.
    #
    #   Token.new('foo: bar').compound? # => true
    #   Token.new('bar').compound?      # => false
    def compound?
      !modifier.nil? && !modifier.empty?
    end

    def inspect # :nodoc:
      format '#<%<cls>s String(%<str>s) modifier=%<mod>s term=%<term>s>',
        cls: self.class,
        str: super,
        mod: modifier.inspect,
        term: term.inspect
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
search_lingo-2.0.0	lib/search_lingo/token.rb
search_lingo-2.0.0.pre3	lib/search_lingo/token.rb