Class: LibGems::ConfigFile

Inherits:
Object
  • Object
show all
Defined in:
lib/libgems/config_file.rb

Overview

LibGems::ConfigFile SlimGems options and gem command options from ~/.gemrc.

~/.gemrc is a YAML file that uses strings to match gem command arguments and symbols to match SlimGems options.

LibGems command arguments use a String key that matches the command name and allow you to specify default arguments:

install: --no-rdoc --no-ri
update: --no-rdoc --no-ri

You can use gem: to set default arguments for all commands.

SlimGems options use symbol keys. Valid options are:

:backtrace

See #backtrace

:benchmark

See #benchmark

:sources

Sets LibGems::sources

:verbose

See #verbose

Constant Summary collapse

DEFAULT_BACKTRACE = 
false
DEFAULT_BENCHMARK = 
false
DEFAULT_BULK_THRESHOLD = 
1000
DEFAULT_VERBOSITY = 
true
DEFAULT_UPDATE_SOURCES = 
true
OPERATING_SYSTEM_DEFAULTS =

For Ruby packagers to set configuration defaults. Set in rubygems/defaults/operating_system.rb

{}
PLATFORM_DEFAULTS =

For Ruby implementers to set configuration defaults. Set in rubygems/defaults/#RUBY_ENGINE.rb

{}
SYSTEM_WIDE_CONFIG_FILE = 
File.join system_config_path, 'gemrc'

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arg_list) ⇒ ConfigFile

Create the config file object. args is the list of arguments from the command line.

The following command line options are handled early here rather than later at the time most command options are processed.

--config-file, --config-file==NAME

Obviously these need to be handled by the ConfigFile object to ensure we get the right config file.

--backtrace

Backtrace needs to be turned on early so that errors before normal option parsing can be properly handled.

--debug

Enable Ruby level debug messages. Handled early for the same reason as –backtrace.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/libgems/config_file.rb', line 139

def initialize(arg_list)
  @config_file_name = nil
  need_config_file_name = false

  arg_list = arg_list.map do |arg|
    if need_config_file_name then
      @config_file_name = arg
      need_config_file_name = false
      nil
    elsif arg =~ /^--config-file=(.*)/ then
      @config_file_name = $1
      nil
    elsif arg =~ /^--config-file$/ then
      need_config_file_name = true
      nil
    else
      arg
    end
  end.compact

  @backtrace = DEFAULT_BACKTRACE
  @benchmark = DEFAULT_BENCHMARK
  @bulk_threshold = DEFAULT_BULK_THRESHOLD
  @verbose = DEFAULT_VERBOSITY
  @update_sources = DEFAULT_UPDATE_SOURCES

  operating_system_config = Marshal.load Marshal.dump(OPERATING_SYSTEM_DEFAULTS)
  platform_config = Marshal.load Marshal.dump(PLATFORM_DEFAULTS)
  system_config = load_file SYSTEM_WIDE_CONFIG_FILE
  user_config = load_file config_file_name.dup.untaint

  @hash = operating_system_config.merge platform_config
  @hash = @hash.merge system_config
  @hash = @hash.merge user_config

  # HACK these override command-line args, which is bad
  @backtrace        = @hash[:backtrace]        if @hash.key? :backtrace
  @benchmark        = @hash[:benchmark]        if @hash.key? :benchmark
  @bulk_threshold   = @hash[:bulk_threshold]   if @hash.key? :bulk_threshold
  @home             = @hash[:gemhome]          if @hash.key? :gemhome
  @path             = @hash[:gempath]          if @hash.key? :gempath
  @update_sources   = @hash[:update_sources]   if @hash.key? :update_sources
  @verbose          = @hash[:verbose]          if @hash.key? :verbose

  load_rubygems_api_key

  LibGems.sources = @hash[:sources] if @hash.key? :sources
  handle_arguments arg_list
end

Instance Attribute Details

#args ⇒ Object (readonly)

List of arguments supplied to the config file object.



74
75
76
 
# File 'lib/libgems/config_file.rb', line 74

def args
  @args
end

#backtrace ⇒ Object

True if the backtrace option has been specified, or debug is on.



230
231
232
 
# File 'lib/libgems/config_file.rb', line 230

def backtrace
  @backtrace or $DEBUG
end

#benchmark ⇒ Object

True if we are benchmarking this run.



94
95
96
 
# File 'lib/libgems/config_file.rb', line 94

def benchmark
  @benchmark
end

#bulk_threshold ⇒ Object

Bulk threshold value. If the number of missing gems are above this threshold value, then a bulk download technique is used. (deprecated)



100
101
102
 
# File 'lib/libgems/config_file.rb', line 100

def bulk_threshold
  @bulk_threshold
end

#home ⇒ Object

Where to install gems (deprecated)



84
85
86
 
# File 'lib/libgems/config_file.rb', line 84

def home
  @home
end

#path ⇒ Object

Where to look for gems (deprecated)



79
80
81
 
# File 'lib/libgems/config_file.rb', line 79

def path
  @path
end

#rubygems_api_key ⇒ Object

API key for SlimGems.org



118
119
120
 
# File 'lib/libgems/config_file.rb', line 118

def rubygems_api_key
  @rubygems_api_key
end

#update_sources ⇒ Object

True if we want to update the SourceInfoCache every time, false otherwise



113
114
115
 
# File 'lib/libgems/config_file.rb', line 113

def update_sources
  @update_sources
end

#verbose ⇒ Object

Verbose level of output:

  • false – No output

  • true – Normal output

  • :loud – Extra output



108
109
110
 
# File 'lib/libgems/config_file.rb', line 108

def verbose
  @verbose
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:



330
331
332
333
334
335
336
337
338
 
# File 'lib/libgems/config_file.rb', line 330

def ==(other) # :nodoc:
  self.class === other and
  @backtrace == other.backtrace and
  @benchmark == other.benchmark and
  @bulk_threshold == other.bulk_threshold and
  @verbose == other.verbose and
  @update_sources == other.update_sources and
  @hash == other.hash
end

#[](key) ⇒ Object

Return the configuration information for key.



321
322
323
 
# File 'lib/libgems/config_file.rb', line 321

def [](key)
  @hash[key.to_s]
end

#[]=(key, value) ⇒ Object

Set configuration option key to value.



326
327
328
 
# File 'lib/libgems/config_file.rb', line 326

def []=(key, value)
  @hash[key.to_s] = value
end

#config_file_name ⇒ Object

The name of the configuration file.



235
236
237
 
# File 'lib/libgems/config_file.rb', line 235

def config_file_name
  @config_file_name || LibGems.config_file
end

#credentials_path ⇒ Object

Location of SlimGems.org credentials



192
193
194
 
# File 'lib/libgems/config_file.rb', line 192

def credentials_path
  File.join(LibGems.user_home, '.gem', 'credentials')
end

#each {|:update_sources, @update_sources| ... } ⇒ Object

Delegates to @hash

Yields:



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/libgems/config_file.rb', line 240

def each(&block)
  hash = @hash.dup
  hash.delete :update_sources
  hash.delete :verbose
  hash.delete :benchmark
  hash.delete :backtrace
  hash.delete :bulk_threshold

  yield :update_sources, @update_sources
  yield :verbose, @verbose
  yield :benchmark, @benchmark
  yield :backtrace, @backtrace
  yield :bulk_threshold, @bulk_threshold

  yield 'config_file_name', @config_file_name if @config_file_name

  hash.each(&block)
end

#handle_arguments(arg_list) ⇒ Object

Handle the command arguments.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/libgems/config_file.rb', line 260

def handle_arguments(arg_list)
  @args = []

  arg_list.each do |arg|
    case arg
    when /^--(backtrace|traceback)$/ then
      @backtrace = true
    when /^--bench(mark)?$/ then
      @benchmark = true
    when /^--debug$/ then
      $DEBUG = true
    else
      @args << arg
    end
  end
end

#load_file(filename) ⇒ Object 



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/libgems/config_file.rb', line 217

def load_file(filename)
  LibGems.load_yaml
  return {} unless filename and File.exists?(filename)
  begin
    YAML.load(File.read(filename))
  rescue ArgumentError
    warn "Failed to load #{config_file_name}"
  rescue Errno::EACCES
    warn "Failed to load #{config_file_name} due to permissions problem."
  end or {}
end

#load_rubygems_api_key ⇒ Object 



196
197
198
199
200
 
# File 'lib/libgems/config_file.rb', line 196

def load_rubygems_api_key
  api_key_hash = File.exists?(credentials_path) ? load_file(credentials_path) : @hash

  @rubygems_api_key = api_key_hash[:rubygems_api_key] if api_key_hash.key? :rubygems_api_key
end

#really_verbose ⇒ Object

Really verbose mode gives you extra output.



278
279
280
281
282
283
 
# File 'lib/libgems/config_file.rb', line 278

def really_verbose
  case verbose
  when true, false, nil then false
  else true
  end
end

#to_yaml ⇒ Object

to_yaml only overwrites things you can’t override on the command line.



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/libgems/config_file.rb', line 286

def to_yaml # :nodoc:
  yaml_hash = {}
  yaml_hash[:backtrace] = @hash.key?(:backtrace) ? @hash[:backtrace] :
    DEFAULT_BACKTRACE
  yaml_hash[:benchmark] = @hash.key?(:benchmark) ? @hash[:benchmark] :
    DEFAULT_BENCHMARK
  yaml_hash[:bulk_threshold] = @hash.key?(:bulk_threshold) ?
    @hash[:bulk_threshold] : DEFAULT_BULK_THRESHOLD
  yaml_hash[:sources] = LibGems.sources
  yaml_hash[:update_sources] = @hash.key?(:update_sources) ?
    @hash[:update_sources] : DEFAULT_UPDATE_SOURCES
  yaml_hash[:verbose] = @hash.key?(:verbose) ? @hash[:verbose] :
    DEFAULT_VERBOSITY

  keys = yaml_hash.keys.map { |key| key.to_s }
  keys << 'debug'
  re = Regexp.union(*keys)

  @hash.each do |key, value|
    key = key.to_s
    next if key =~ re
    yaml_hash[key.to_s] = value
  end

  yaml_hash.to_yaml
end

#write ⇒ Object

Writes out this config file, replacing its source.



314
315
316
317
318
 
# File 'lib/libgems/config_file.rb', line 314

def write
  open config_file_name, 'w' do |io|
    io.write to_yaml
  end
end