Class: R10K::Module::Forge

Inherits:
Base
  • Object
show all
Includes:
Logging
Defined in:
lib/r10k/module/forge.rb

Constant Summary

Constants included from Logging

Logging::LOG_LEVELS

Instance Attribute Summary collapse

Attributes inherited from Base

#basedir, #name

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Logging

formatter, included, level, level=, levels, #logger, #logger_name, outputter, parse_level

Methods inherited from Base

#full_path

Constructor Details

#initialize(full_name, basedir, args) ⇒ Forge

Returns a new instance of Forge.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/r10k/module/forge.rb', line 35

def initialize(full_name, basedir, args)
  @full_name = full_name
  @basedir   = basedir

  @author, @name = full_name.split('/')

  @full_path = Pathname.new(File.join(@basedir, @name))

  @metadata = R10K::Module::Metadata.new(@full_path + 'metadata.json')

  if args.is_a? String
    @expected_version = R10K::SemVer.new(args)
  elsif args.is_a? Symbol and args == :latest
    @expected_version = args
  end
end

Instance Attribute Details

#author ⇒ Object (readonly)

Returns the value of attribute author.



23
24
25
 
# File 'lib/r10k/module/forge.rb', line 23

def author
  @author
end

#full_name ⇒ Object (readonly)

Returns the value of attribute full_name.



33
34
35
 
# File 'lib/r10k/module/forge.rb', line 33

def full_name
  @full_name
end

Class Method Details

.implement?(name, args) ⇒ Boolean

Returns:

  • (Boolean) 


15
16
17
 
# File 'lib/r10k/module/forge.rb', line 15

def self.implement?(name, args)
  !!(name.match %r[\w+/\w+])
end

Instance Method Details

#current_version ⇒ R10K::SemVer Also known as: version

Returns The version of the currently installed module.

Returns:

  • (R10K::SemVer) —

    The version of the currently installed module



73
74
75
 
# File 'lib/r10k/module/forge.rb', line 73

def current_version
  @metadata.version
end

#exist? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/r10k/module/forge.rb', line 79

def exist?
  @full_path.exist?
end

#expected_version ⇒ R10K::SemVer

Returns The expected version that the module.

Returns:



64
65
66
67
68
69
 
# File 'lib/r10k/module/forge.rb', line 64

def expected_version
  if @expected_version == :latest
    set_version_from_forge
  end
  @expected_version
end

#insync? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/r10k/module/forge.rb', line 83

def insync?
  status == :insync
end

#owner ⇒ Object

Deprecated. 


26
27
28
29
 
# File 'lib/r10k/module/forge.rb', line 26

def owner
  logger.warn "#{self.inspect}#owner is deprecated; use #author instead"
  @author
end

#status ⇒ Symbol

Determine the status of the forge module.

Returns:

  • (Symbol) —

    :absent If the directory doesn’t exist

  • (Symbol) —

    :mismatched If the module is not a forge module, or isn’t the right forge module

  • (Symbol) —

    :outdated If the installed module is older than expected

  • (Symbol) —

    :insync If the module is in the desired state



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/r10k/module/forge.rb', line 94

def status
  if not self.exist?
    # The module is not installed
    return :absent
  elsif not @metadata.exist?
    # The directory exists but doesn't have a metadata file; it probably
    # isn't a forge module.
    return :mismatched
  end

  # The module is present and has a metadata file, read the metadata to
  # determine the state of the module.
  @metadata.read

  if not @author == @metadata.author
    # This is a forge module but the installed module is a different author
    # than the expected author.
    return :mismatched
  end

  if expected_version && (expected_version != @metadata.version)
    return :outdated
  end

  return :insync
end

#sync(options = {}) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/r10k/module/forge.rb', line 52

def sync(options = {})
  case status
  when :absent
    install
  when :outdated
    upgrade
  when :mismatched
    reinstall
  end
end