Class: Fig::Repository

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

Overview

Overall management of a repository. Handles local operations itself; defers remote operations to others.

Constant Summary collapse

METADATA_SUBDIRECTORY = 
'_meta'
RESOURCES_FILE = 
'resources.tar.gz'
VERSION_FILE_NAME = 
'repository-format-version'
VERSION_SUPPORTED = 
1

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(os, local_repository_directory, application_config, remote_repository_user, update, update_if_missing, check_include_versions) ⇒ Repository

Returns a new instance of Repository.



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/fig/repository.rb', line 32

def initialize(
  os,
  local_repository_directory,
  application_config,
  remote_repository_user,
  update,
  update_if_missing,
  check_include_versions
)
  @operating_system             = os
  @local_repository_directory   = local_repository_directory
  @application_config           = application_config
  @remote_repository_user       = remote_repository_user
  @update                       = update
  @update_if_missing            = update_if_missing

  @parser = Fig::Parser.new(application_config, check_include_versions)

  initialize_local_repository()
  reset_cached_data()
end

Class Method Details

.is_url?(url) ⇒ Boolean

Returns:

  • (Boolean) 


28
29
30
 
# File 'lib/fig/repository.rb', line 28

def self.is_url?(url)
  not (/ftp:\/\/|http:\/\/|file:\/\/|ssh:\/\// =~ url).nil?
end

Instance Method Details

#clean(descriptor) ⇒ Object 



119
120
121
122
123
124
125
126
127
 
# File 'lib/fig/repository.rb', line 119

def clean(descriptor)
  check_local_repository_format()

  @package_cache.remove_package(descriptor.name, descriptor.version)

  FileUtils.rm_rf(local_dir_for_package(descriptor))

  return
end

#get_package(descriptor, allow_any_version = false) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/fig/repository.rb', line 82

def get_package(
  descriptor,
  allow_any_version = false
)
  check_local_repository_format()

  if not descriptor.version
    if allow_any_version
      package = @package_cache.get_any_version_of_package(descriptor.name)
      if package
        Fig::Logging.warn(
          "Picked version #{package.version} of #{package.name} at random."
        )
        return package
      end
    end

    raise Fig::RepositoryError.new(
      %Q<Cannot retrieve "#{descriptor.name}" without a version.>
    )
  end

  package = @package_cache.get_package(descriptor.name, descriptor.version)
  return package if package

  Fig::Logging.debug \
    "Considering #{Fig::PackageDescriptor.format(descriptor.name, descriptor.version, nil)}."

  if should_update?(descriptor)
    check_remote_repository_format()

    update_package(descriptor)
  end

  return read_local_package(descriptor)
end

#list_packages ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/fig/repository.rb', line 58

def list_packages
  check_local_repository_format()

  results = []
  if File.exist?(local_package_directory())
    @operating_system.list(local_package_directory()).each do |name|
      @operating_system.list(File.join(local_package_directory(), name)).each do
        |version|
        results << Fig::PackageDescriptor.format(name, version, nil)
      end
    end
  end

  return results
end

#list_remote_packages ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/fig/repository.rb', line 74

def list_remote_packages
  check_remote_repository_format()

  paths = @operating_system.download_list(remote_repository_url())

  return paths.reject { |path| path =~ %r< ^ #{METADATA_SUBDIRECTORY} / >xs }
end

#publish_package(package_statements, descriptor, local_only) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/fig/repository.rb', line 129

def publish_package(package_statements, descriptor, local_only)
  check_local_repository_format()
  if not local_only
    check_remote_repository_format()
  end

  validate_asset_names(package_statements)

  temp_dir = publish_temp_dir()
  @operating_system.delete_and_recreate_directory(temp_dir)
  local_dir = local_dir_for_package(descriptor)
  @operating_system.delete_and_recreate_directory(local_dir)
  fig_file = File.join(temp_dir, PACKAGE_FILE_IN_REPO)
  content = publish_package_content_and_derive_dot_fig_contents(
    package_statements, descriptor, local_dir, local_only
  )
  @operating_system.write(fig_file, content)

  if not local_only
    @operating_system.upload(
      fig_file,
      remote_fig_file_for_package(descriptor),
      @remote_repository_user
    )
  end
  @operating_system.copy(
    fig_file, local_fig_file_for_package(descriptor)
  )

  FileUtils.rm_rf(temp_dir)

  return true
end

#reset_cached_data ⇒ Object 



54
55
56
 
# File 'lib/fig/repository.rb', line 54

def reset_cached_data()
  @package_cache = Fig::PackageCache.new()
end

#updating? ⇒ Boolean

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/fig/repository.rb', line 163

def updating?
  return @update || @update_if_missing
end