Class: Bolt::ResultSet

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/bolt/result_set.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(results) ⇒ ResultSet

Returns a new instance of ResultSet.



24
25
26
# File 'lib/bolt/result_set.rb', line 24

def initialize(results)
  @results = results
end

Instance Attribute Details

#resultsObject (readonly)

Returns the value of attribute results.



5
6
7
# File 'lib/bolt/result_set.rb', line 5

def results
  @results
end

Class Method Details

.include_iterableObject

We only want want to include these when puppet is loaded



10
11
12
13
# File 'lib/bolt/result_set.rb', line 10

def self.include_iterable
  include(Puppet::Pops::Types::Iterable)
  include(Puppet::Pops::Types::IteratorProducer)
end

Instance Method Details

#==(other) ⇒ Object



106
107
108
# File 'lib/bolt/result_set.rb', line 106

def ==(other)
  eql?(other)
end

#countObject Also known as: length, size



44
45
46
# File 'lib/bolt/result_set.rb', line 44

def count
  @results.size
end

#eachObject



28
29
30
31
# File 'lib/bolt/result_set.rb', line 28

def each
  @results.each { |r| yield r }
  self
end

#emptyObject Also known as: empty?



50
51
52
# File 'lib/bolt/result_set.rb', line 50

def empty
  @results.empty?
end

#eql?(other) ⇒ Boolean

Returns:

  • (Boolean)


86
87
88
# File 'lib/bolt/result_set.rb', line 86

def eql?(other)
  self.class == other.class && @results == other.results
end

#error_setObject



68
69
70
71
# File 'lib/bolt/result_set.rb', line 68

def error_set
  filtered = @results.reject(&:ok?)
  ResultSet.new(filtered)
end

#filter_setObject



33
34
35
36
# File 'lib/bolt/result_set.rb', line 33

def filter_set
  filtered = @results.select { |r| yield r }
  self.class.new(filtered)
end

#find(target_name) ⇒ Object



78
79
80
# File 'lib/bolt/result_set.rb', line 78

def find(target_name)
  result_hash[target_name]
end

#firstObject



82
83
84
# File 'lib/bolt/result_set.rb', line 82

def first
  @results.first
end

#iteratorObject



15
16
17
18
19
20
21
22
# File 'lib/bolt/result_set.rb', line 15

def iterator
  if Object.const_defined?(:Puppet) && Puppet.const_defined?(:Pops) &&
     self.class.included_modules.include?(Puppet::Pops::Types::Iterable)
    Puppet::Pops::Types::Iterable.on(@results, Bolt::Result)
  else
    raise NotImplementedError, "iterator requires puppet code to be loaded."
  end
end

#namesObject



59
60
61
# File 'lib/bolt/result_set.rb', line 59

def names
  @results.map { |r| r.target.name }
end

#okObject Also known as: ok?



63
64
65
# File 'lib/bolt/result_set.rb', line 63

def ok
  @results.all?(&:ok?)
end

#ok_setObject



73
74
75
76
# File 'lib/bolt/result_set.rb', line 73

def ok_set
  filtered = @results.select(&:success?)
  self.class.new(filtered)
end

#result_hashObject



38
39
40
41
42
# File 'lib/bolt/result_set.rb', line 38

def result_hash
  @result_hash ||= @results.each_with_object({}) do |result, acc|
    acc[result.target.name] = result
  end
end

#targetsObject



55
56
57
# File 'lib/bolt/result_set.rb', line 55

def targets
  results.map(&:target)
end

#to_aObject



90
91
92
# File 'lib/bolt/result_set.rb', line 90

def to_a
  @results.map(&:status_hash)
end

#to_dataObject



98
99
100
# File 'lib/bolt/result_set.rb', line 98

def to_data
  @results.map(&:to_data)
end

#to_json(opts = nil) ⇒ Object



94
95
96
# File 'lib/bolt/result_set.rb', line 94

def to_json(opts = nil)
  @results.map(&:status_hash).to_json(opts)
end

#to_sObject



102
103
104
# File 'lib/bolt/result_set.rb', line 102

def to_s
  to_json
end