Class: RSence::Dependencies

Inherits:
Object
  • Object
show all
Defined in:
lib/rsence/dependencies.rb

Overview

Description:

Generic dependency calculator. Used by PluginManager.

Usage:

This is an almost real world example:

## Initialize with pre-satisfied dependencies
deps = RSence::Dependencies.new( [:foo1,:foo2] )

## :client_pkg doesn't depend on anything
deps.set_deps( :client_pkg, nil )

## :system is the category of :client_pkg
deps.set_deps( :system, :client_pkg )

## :index_html depends on :client_pkg
deps.set_deps( :index_html, :client_pkg )

## :system is the category of :index_html
deps.set_deps( :system, :index_html )

## :main depends on :index_html
deps.set_deps( :main, :index_html )

## :system is the category of :main
deps.set_deps( :system, :main )

## :impossible has several dependencies, of which :foo3 can't be satisfied
deps.set_deps( :impossible, [:foo1, :foo2, :foo3] )

## :ticket has no dependencies
deps.set_deps( :ticket, nil )

## :system is the category of :ticket
deps.set_deps( :system, :ticket )

## :welcome depends on the :system category
deps.set_deps( :welcome, :system )

## :first doesn't depend on anything
deps.set_deps( :first, nil )

## Prepending is handled like this:
deps.set_deps( :client_pkg, :first )
deps.set_deps( :ticket, :first )

## Calculates the list of dependencies and returns them in an Array
p deps.list

## Output of the example above:
# impossible dependencies:
#   :impossible => [:foo3]
# [:foo1, :foo2, :first, :ticket, :client_pkg, :index_html, :main, :system, :welcome]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(resolved = [], categories = {}, quiet = true) ⇒ Dependencies

Don’t use Dependencies for external projects yet. It’s subject to change without deprecation warnings. resolved and categories are optional.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/rsence/dependencies.rb', line 68

def initialize( resolved = [], categories = {}, quiet=true )
  @quiet = quiet
  @pre_resolved = resolved.clone
  @depends_on = {
    # :name => [ :dep1, :dep2, :dep3, ... ]
  }
  @dependencies_of = {
    #:dep1 => [ :name1, :name2, ... ]
  }
  @categories = []
  categories.each_key do |cat_name, cat_items|
    add_category( cat_name )
    set_deps( cat_name, nil )
  end
  @unresolved = []
  recalculate!
end

Instance Attribute Details

#categories ⇒ Object (readonly)

List of categories



128
129
130
 
# File 'lib/rsence/dependencies.rb', line 128

def categories
  @categories
end

Instance Method Details

#add_category(name) ⇒ Object

Adds the category name.



131
132
133
 
# File 'lib/rsence/dependencies.rb', line 131

def add_category( name )
  @categories.push( name ) unless @categories.include?( name )
end

#category?(name) ⇒ Boolean

Returns true, if name is a category.

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/rsence/dependencies.rb', line 142

def category?( name )
  @categories.include?( name )
end

#clone_dependencies_of ⇒ Object

Returns clone of the @dependencies_of Array



182
183
184
 
# File 'lib/rsence/dependencies.rb', line 182

def clone_dependencies_of
  Marshal.load( Marshal.dump( @dependencies_of ) )
end

#clone_depends_on ⇒ Object

Returns copy of the @depends_on Array



177
178
179
 
# File 'lib/rsence/dependencies.rb', line 177

def clone_depends_on
  Marshal.load( Marshal.dump( @depends_on ) )
end

#del_category(name) ⇒ Object

Deletes the category name, but doesn’t dissolve its dependencies. Essentially turns name into a regular item.



137
138
139
 
# File 'lib/rsence/dependencies.rb', line 137

def del_category( name )
  @categories.delete( name ) if @categories.include?( name )
end

#del_deps(name) ⇒ Object

Deletes name and all dependencies of name



222
223
224
225
226
 
# File 'lib/rsence/dependencies.rb', line 222

def del_deps( name )
  del_order( name ).each do |del_name|
    del_item( del_name )
  end
end

#del_item(name) ⇒ Object

Remove name from dependency system, throws error if it’s depended on another item.



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/rsence/dependencies.rb', line 187

def del_item( name )
  d_of = deps_of( name )
  if not d_of.empty?
    d_of.each do |dep|
      if category?( dep )
        @depends_on[ dep ].delete( name )
      else
        throw "Dependencies.del_item error: the following items depend on #{name.inspect} -> #{deps_of(name).inspect}"
      end
    end
  end
  unless category?( name )
    deps_on( name ).each do |dep|
      @dependencies_of[dep].delete(name) if @dependencies_of.has_key?(dep)
    end
    @depends_on.delete( name )
    @dependencies_of.delete( name )
  end
  recalculate!
end

#del_order(name) ⇒ Object

Returns the order of deletion possible without breaking the dependency chain



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/rsence/dependencies.rb', line 209

def del_order( name )
  d_order = []
  d_of = deps_of( name )
  list.reverse.each do |dep|
    if d_of.include?( dep )
      d_order.push( dep )
    end
  end
  d_order.push( name )
  return d_order
end

#deps_of(name) ⇒ Object Also known as: dependencies_of

Returns list of items that are dependencies of name in no particular order.



98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/rsence/dependencies.rb', line 98

def deps_of( name )
  outp = []
  if @dependencies_of.has_key?(name)
    @dependencies_of[name].each do |dep|
      outp.push( dep )
      outp += deps_of( dep )
    end
  end
  outp.uniq!
  outp.delete( name )
  return outp
end

#deps_on(name) ⇒ Object Also known as: depends_on

Returns list of items that name depends on in no particular order.



113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/rsence/dependencies.rb', line 113

def deps_on( name )
  outp = []
  if @depends_on.has_key?(name)
    @depends_on[name].each do |dep|
      outp.push( dep )
      outp += deps_on( dep )
    end
  end
  outp.uniq!
  outp.delete( name )
  return outp
end

#list ⇒ Object Also known as: load_order

Returns dependencies sorted in load order



279
280
281
 
# File 'lib/rsence/dependencies.rb', line 279

def list
  @resolved.clone
end

#loadable?(name) ⇒ Boolean

Returns true, if name is not a pre-resolved dependency and not a category.

Returns:

  • (Boolean) 


92
93
94
 
# File 'lib/rsence/dependencies.rb', line 92

def loadable?( name )
  return (not pre_resolved?(name) and not category?(name))
end

#pre_resolved?(name) ⇒ Boolean

Returns true, if name is a pre-resolved dependency.

Returns:

  • (Boolean) 


87
88
89
 
# File 'lib/rsence/dependencies.rb', line 87

def pre_resolved?( name )
  @pre_resolved.include?( name )
end

#recalculate! ⇒ Object

Recalculates the list and unresolved items.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/rsence/dependencies.rb', line 240

def recalculate!
  unresolved = []
  resolved = @pre_resolved.clone
  same_len = false
  depends_on = clone_depends_on
  target_len = depends_on.keys.length + resolved.length
  until resolved.length == target_len
    len = resolved.length
    depends_on.each do | name, deps |
      if deps.empty? and not resolved.include?(name)
        resolved.push( name )
      elsif deps.empty?
        next
      else
        deps.each do |dep|
          deps.delete(dep) if resolved.include?(dep)
        end
      end
    end
    if len == resolved.length
      if same_len
        warn "impossible dependencies:" unless @quiet
        (depends_on.keys - resolved).each do |unsatisfied|
          warn "  #{unsatisfied.inspect} => #{depends_on[unsatisfied].inspect}" unless @quiet
          unresolved.push( unsatisfied )
        end
        break
      else
        same_len = true
      end
    else
      same_len = false
    end
  end
  @unresolved = unresolved
  @resolved = resolved
end

#resolved?(name) ⇒ Boolean

Returns true, if name is resolved (a valid dependency). Inverse of self#unresolved?

Returns:

  • (Boolean) 


235
236
237
 
# File 'lib/rsence/dependencies.rb', line 235

def resolved?( name )
  (not unresolved?( name ))
end

#set_deps(name, deps) ⇒ Object Also known as: set_dependencies, set_dependency

Set list of dependency names as deps that name depends on



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
 
# File 'lib/rsence/dependencies.rb', line 147

def set_deps( name, deps )
  if deps.class == Symbol
    deps = [deps]
  elsif deps.class == String
    deps = [deps.to_sym]
  elsif deps.class == NilClass
    deps = []
  elsif deps.class != Array
    raise "Dependencies.set_deps error: the deps is an unsupported type: #{deps.class}"
  end
  if not @depends_on.has_key?(name)
    @depends_on[name] = deps
  else
    deps.each do |dep|
      @depends_on[name].push( dep ) unless @depends_on[name].include?( dep )
    end
  end
  deps.each do |dep|
    if not @dependencies_of.has_key?( dep )
      @dependencies_of[dep] = [name]
    elsif not @dependencies_of[dep].include?( name )
      @dependencies_of[dep].push( name )
    end
  end
  recalculate!
end

#unresolved?(name) ⇒ Boolean

Returns true, if name is unresolved. The list of unresolved items is updated every time self#recalculate is called.

Returns:

  • (Boolean) 


230
231
232
 
# File 'lib/rsence/dependencies.rb', line 230

def unresolved?( name )
  @unresolved.include?( name )
end