Class: Fig::WorkingDirectoryMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/fig/working_directory_metadata.rb

Overview

Data about a package within the current working directory.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(package_name, current_version = nil) ⇒ WorkingDirectoryMetadata

Returns a new instance of WorkingDirectoryMetadata.



9
10
11
12
13
14
# File 'lib/fig/working_directory_metadata.rb', line 9

def initialize(package_name, current_version = nil)
  @package_name    = package_name
  @retrieved       = false

  reset_with_version(current_version)
end

Instance Attribute Details

#current_versionObject (readonly)

Returns the value of attribute current_version.



7
8
9
# File 'lib/fig/working_directory_metadata.rb', line 7

def current_version
  @current_version
end

#package_nameObject (readonly)

Returns the value of attribute package_name.



7
8
9
# File 'lib/fig/working_directory_metadata.rb', line 7

def package_name
  @package_name
end

Instance Method Details

#add_file(file) ⇒ Object



23
24
25
26
27
# File 'lib/fig/working_directory_metadata.rb', line 23

def add_file(file)
  @files << file

  return
end

#each_fileObject

So we don’t have to expose the files collection.



40
41
42
43
44
# File 'lib/fig/working_directory_metadata.rb', line 40

def each_file()
  @files.each {|file| yield file}

  return
end

#mark_as_retrievedObject



29
30
31
32
33
# File 'lib/fig/working_directory_metadata.rb', line 29

def mark_as_retrieved()
  @retrieved = true

  return
end

#reset_with_version(new_version) ⇒ Object



16
17
18
19
20
21
# File 'lib/fig/working_directory_metadata.rb', line 16

def reset_with_version(new_version)
  @current_version = new_version
  @files           = Set.new

  return
end

#retrieved?Boolean

Returns:

  • (Boolean)


35
36
37
# File 'lib/fig/working_directory_metadata.rb', line 35

def retrieved?()
  return @retrieved
end