Class: Comet::SourceIncludePattern

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/source_include_pattern.rb

Overview

(ENGINE_BUILTIN_FILE). It should be marshalled as JSON and then stored in the PINCLUDE / RINCLUDE EngineProp keys.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SourceIncludePattern

Returns a new instance of SourceIncludePattern.



29
30
31
 
# File 'lib/comet/models/source_include_pattern.rb', line 29

def initialize
  clear
end

Instance Attribute Details

#top_directory ⇒ Object

The filesystem path to search within, for matches



20
21
22
 
# File 'lib/comet/models/source_include_pattern.rb', line 20

def top_directory
  @top_directory
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



27
28
29
 
# File 'lib/comet/models/source_include_pattern.rb', line 27

def unknown_json_fields
  @unknown_json_fields
end

#value ⇒ Object

The pattern (glob or regex format) to match



24
25
26
 
# File 'lib/comet/models/source_include_pattern.rb', line 24

def value
  @value
end

Instance Method Details

#clear ⇒ Object 



33
34
35
36
37
 
# File 'lib/comet/models/source_include_pattern.rb', line 33

def clear
  @top_directory = ''
  @value = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/comet/models/source_include_pattern.rb', line 47

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'TopDirectory'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @top_directory = v
    when 'Value'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @value = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


40
41
42
43
44
 
# File 'lib/comet/models/source_include_pattern.rb', line 40

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



78
79
80
 
# File 'lib/comet/models/source_include_pattern.rb', line 78

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



67
68
69
70
71
72
73
74
75
 
# File 'lib/comet/models/source_include_pattern.rb', line 67

def to_hash
  ret = {}
  ret['TopDirectory'] = @top_directory
  ret['Value'] = @value
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



83
84
85
 
# File 'lib/comet/models/source_include_pattern.rb', line 83

def to_json(options = {})
  to_hash.to_json(options)
end