module GemMirror::CLI

Namespace for classes and modules that handle the command line interface

Constants

SLOP_OPTIONS

Hash containing the default Slop options.

@return [Hash]

Public Class Methods

default_options() click to toggle source

@return [Slop]

   # File lib/gem_mirror/cli.rb
43 def self.default_options
44   Slop.new(SLOP_OPTIONS.dup) do
45     separator "\nOptions:\n"
46 
47     on :h, :help, "Shows this help message" do
48       puts self
49       exit
50     end
51 
52     on :v, :version, "Shows the current version" do
53       puts CLI.version_information
54     end
55   end
56 end
load_configuration(config_file) click to toggle source

Loads the specified configuration file or displays an error if it doesn't exist.

@param [String] config_file @return [GemMirror::Configuration]

   # File lib/gem_mirror/cli.rb
31 def self.load_configuration(config_file)
32   config_file ||= Configuration.default_configuration_file
33   config_file   = File.expand_path(config_file, Dir.pwd)
34 
35   abort "The configuration file #{config_file} does not exist" unless File.file?(config_file)
36 
37   require(config_file)
38 end
options() click to toggle source

@return [Slop]

   # File lib/gem_mirror/cli.rb
20 def self.options
21   @options ||= default_options
22 end
version_information() click to toggle source

Returns a String containing some platform/version related information.

@return [String]

   # File lib/gem_mirror/cli.rb
63 def self.version_information
64   "gem_mirror v#{GemMirror::VERSION} on #{RUBY_DESCRIPTION}"
65 end