Module: Mattock::Configurable::DirectoryStructure::ClassMethods

Defined in:
lib/mattock/configurable/directory-structure.rb

Constant Summary collapse

RequiredField = 
Configurable::RequiredField

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#path_heirarchy ⇒ Object 



51
52
53
 
# File 'lib/mattock/configurable/directory-structure.rb', line 51

def path_heirarchy
  @path_heirarchy ||= []
end

Instance Method Details

#dir(field_name, *args) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/mattock/configurable/directory-structure.rb', line 60

def dir(field_name, *args)
  rel_path = RequiredField
  if String === args.first
    rel_path = args.shift
  end
  parent_field = path(field_name, rel_path)

  root_paths << parent_field
  self.path_heirarchy += args.map do |child_field|
    [parent_field, child_field]
  end
  return parent_field
end

#path(field_name, rel_path = RequiredField) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/mattock/configurable/directory-structure.rb', line 74

def path(field_name, rel_path=RequiredField)
  field = setting(field_name, StructurePath.new(rel_path))
  root_paths << field
  path_fields << field
  return field
end

#path_fields ⇒ Object 



56
57
58
 
# File 'lib/mattock/configurable/directory-structure.rb', line 56

def path_fields
  @path_fields ||= []
end

#resolve_path_on(instance, parent, child_field, missing_relatives) ⇒ Object 



81
82
83
84
85
86
87
88
89
 
# File 'lib/mattock/configurable/directory-structure.rb', line 81

def resolve_path_on(instance, parent, child_field, missing_relatives)
  child = child_field.value_on(instance)
  return unless child.field_unset?(:absolute_path)
  if child.field_unset?(:relative_path)
    missing_relatives << child_field
    return
  end
  child.absolute_path = File::join(parent.absolute_path, child.relative_path)
end

#resolve_paths_on(instance) ⇒ Object 



91
92
93
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
120
121
122
123
124
125
 
# File 'lib/mattock/configurable/directory-structure.rb', line 91

def resolve_paths_on(instance)
  superclass_exception = nil
  if superclass < DirectoryStructure
    begin
    superclass.resolve_paths_on(instance)
    rescue MissingRelativePaths => mrp
      superclass_exception = mrp
    end
  end
  missing_relatives = []

  (root_paths - path_heirarchy.map{|_, child| child }).each do |field|
    resolve_path_on(instance, instance, field, missing_relatives)
  end

  path_heirarchy.reverse.each do |parent_field, child_field|
    parent = parent_field.value_on(instance)
    resolve_path_on(instance, parent, child_field, missing_relatives)
  end

  case [missing_relatives.empty?, superclass_exception.nil?]
  when [true, false]
    raise superclass_exception
  when [false, true]
    raise MissingRelativePaths, "Required field#{missing_relatives.length == 1 ? "" : "s"} #{missing_relatives.map{|field| "#{field.name}.relative_path".inspect}.join(", ")} unset on #{self.inspect}"
  when [false, false]
    raise MissingRelativePaths, "Required field#{missing_relatives.length == 1 ? "" : "s"} #{missing_relatives.map{|field| "#{field.name}.relative_path".inspect}.join(", ")} unset on #{self.inspect}" + "\n" + superclass_exception.message
  end

  path_fields.each do |field|
    value = field.value_on(instance)
    next unless value.field_unset?(:relative_path)
    value.relative_path = value.absolute_path
  end
end

#root_paths ⇒ Object 



47
48
49
 
# File 'lib/mattock/configurable/directory-structure.rb', line 47

def root_paths
  @root_paths ||= []
end