Class: Mustermann::Shell

Inherits:

Pattern

• Object
• Pattern
• Mustermann::Shell

Defined in:

lib/mustermann/shell.rb

Overview

Matches strings that are identical to the pattern.

Examples:

Mustermann.new('/*.*', type: :shell) === '/bar' # => false

See Also:

• Pattern
• Syntax description in the README

Instance Method Summary

• #===(string) ⇒ Boolean

  Whether or not the pattern matches the given string.

• #initialize(string, **options) ⇒ Shell, Pattern constructor

Methods inherited from Pattern

#=~, #expand, #match, #named_captures, #names, new, #params, supported?, supported_options, #to_s

Methods included from Mustermann

[], new

Constructor Details

#initialize(string, **options) ⇒ Shell, Pattern

Parameters:

• string (String) —

  the string representation of the pattern

• options (Hash) —

  options for fine-tuning the pattern behavior

See Also:

• "Types and Options" in the README
• Mustermann.new

# File 'lib/mustermann/shell.rb', line 16

def initialize(string, **options)
  @flags = File::FNM_PATHNAME | File::FNM_DOTMATCH
  @flags |= File::FNM_EXTGLOB if defined? File::FNM_EXTGLOB
  super(string, **options)
end

Instance Method Details

#===(string) ⇒ Boolean

Returns Whether or not the pattern matches the given string.

Parameters:

• string (String) —

  The string to match against

Returns:

• (Boolean) —

  Whether or not the pattern matches the given string

See Also:

• Regexp#===

# File 'lib/mustermann/shell.rb', line 25

def ===(string)
  File.fnmatch? @string, unescape(string), @flags
end