Module: Path

Defined in:
lib/rbbt/resource/path.rb,
lib/rbbt/resource/util.rb

Constant Summary collapse

SEARCH_PATHS = 
IndiferentHash.setup({
  :current => File.join("{PWD}", "{TOPLEVEL}", "{SUBPATH}"),
  :user    => File.join(ENV['HOME'], ".{PKGDIR}", "{TOPLEVEL}", "{SUBPATH}"),
  :global  => File.join('/', "{TOPLEVEL}", "{PKGDIR}", "{SUBPATH}"),
  :local   => File.join('/usr/local', "{TOPLEVEL}", "{PKGDIR}", "{SUBPATH}"),
  :fast   => File.join('/fast', "{TOPLEVEL}", "{PKGDIR}", "{SUBPATH}"),
  :cache   => File.join('/cache', "{TOPLEVEL}", "{PKGDIR}", "{SUBPATH}"),
  :bulk   => File.join('/bulk', "{TOPLEVEL}", "{PKGDIR}", "{SUBPATH}"),
  :lib     => File.join('{LIBDIR}', "{TOPLEVEL}", "{SUBPATH}"),
  :default => :user
})
STANDARD_SEARCH = 
%w(current user local global lib fast cache bulk)
SLASH = 
"/"[0]
DOT = 
"."[0]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, prev = nil, *args, &block) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/rbbt/resource/path.rb', line 62

def method_missing(name, prev = nil, *args, &block)
  if block_given?
    super name, prev, *args, &block
  else
    # Fix problem with ruby 1.9 calling methods by its own initiative. ARG
    super(name, prev, *args) if name.to_s =~ /^to_/
    if prev.nil?
      join name
    else
      join(prev).join(name)
    end
  end
end

Instance Attribute Details

#original ⇒ Object

Returns the value of attribute original.



5
6
7
 
# File 'lib/rbbt/resource/path.rb', line 5

def original
  @original
end

#pkgdir ⇒ Object

Returns the value of attribute pkgdir.



5
6
7
 
# File 'lib/rbbt/resource/path.rb', line 5

def pkgdir
  @pkgdir
end

#resource ⇒ Object

Returns the value of attribute resource.



5
6
7
 
# File 'lib/rbbt/resource/path.rb', line 5

def resource
  @resource
end

#search_paths ⇒ Object

Returns the value of attribute search_paths.



5
6
7
 
# File 'lib/rbbt/resource/path.rb', line 5

def search_paths
  @search_paths
end

Class Method Details

.caller_lib_dir(file = nil, relative_to = 'lib') ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/rbbt/resource/util.rb', line 3

def self.caller_lib_dir(file = nil, relative_to = 'lib')
  file = caller.reject{|l| 
    l =~ /rbbt\/(?:resource\.rb|workflow\.rb)/ or
    l =~ /rbbt\/resource\/path\.rb/ or
    l =~ /rbbt\/util\/misc\.rb/ or
    l =~ /progress-monitor\.rb/ 
  }.first.sub(/\.rb[^\w].*/,'.rb') if file.nil?

  file = File.expand_path(file)
  return Path.setup(file) if File.exist? File.join(file, relative_to)

  while file != '/'
    dir = File.dirname file

    return Path.setup(dir) if File.exist? File.join(dir, relative_to)

    file = File.dirname file
  end

  return nil
end

.setup(string, pkgdir = nil, resource = nil, search_paths = nil) ⇒ Object 



7
8
9
10
11
12
13
14
15
 
# File 'lib/rbbt/resource/path.rb', line 7

def self.setup(string, pkgdir = nil, resource = nil, search_paths = nil)
  return string if string.nil?
  string = string.dup if string.frozen?
  string.extend Path
  string.pkgdir = pkgdir || 'rbbt'
  string.resource = resource
  string.search_paths = search_paths
  string
end

Instance Method Details

#[](name, orig = false) ⇒ Object 



53
54
55
56
 
# File 'lib/rbbt/resource/path.rb', line 53

def [](name, orig = false)
  return super(name) if orig
  join name
end

#_exists? ⇒ Boolean

Returns:

  • (Boolean) 


197
198
199
 
# File 'lib/rbbt/resource/path.rb', line 197

def _exists?
  Open.exists? self.find.to_s
end

#all_fields ⇒ Object 



293
294
295
296
297
 
# File 'lib/rbbt/resource/path.rb', line 293

def all_fields
  self.open do |stream|
    TSV.parse_header(stream).all_fields
  end
end

#annotate(name) ⇒ Object 



21
22
23
 
# File 'lib/rbbt/resource/path.rb', line 21

def annotate(name)
  Path.setup name.to_s, @pkgdir, @resource, @search_paths
end

#basename ⇒ Object 



237
238
239
 
# File 'lib/rbbt/resource/path.rb', line 237

def basename
  Path.setup(File.basename(self), self.resource, self.pkgdir)
end

#byte(pos) ⇒ Object 



58
59
60
 
# File 'lib/rbbt/resource/path.rb', line 58

def byte(pos)
  send(:[], pos, true)
end

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


38
39
40
41
 
# File 'lib/rbbt/resource/path.rb', line 38

def directory?
  return nil unless self.exists?
  File.directory? self.find 
end

#dirname ⇒ Object 



34
35
36
 
# File 'lib/rbbt/resource/path.rb', line 34

def dirname
  Path.setup File.dirname(self), @pkgdir, @resource
end

#doc_file(relative_to = 'lib') ⇒ Object 



320
321
322
323
324
325
326
327
328
 
# File 'lib/rbbt/resource/path.rb', line 320

def doc_file(relative_to = 'lib')
  if located?
    lib_dir = Path.caller_lib_dir(self, relative_to)
    relative_file = File.join( 'doc', self.sub(lib_dir,''))
    Path.setup File.join(lib_dir, relative_file) , @pkgdir, @resource
  else
    Path.setup File.join('doc', self) , @pkgdir, @resource
  end
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
204
205
206
207
208
 
# File 'lib/rbbt/resource/path.rb', line 201

def exists?
  begin
    self.produce
    _exists?
  rescue Exception
    false
  end
end

#fields ⇒ Object 



289
290
291
 
# File 'lib/rbbt/resource/path.rb', line 289

def fields
  TSV.parse_header(self.open).fields
end

#filename ⇒ Object 



193
194
195
 
# File 'lib/rbbt/resource/path.rb', line 193

def filename
  self.find
end

#find(where = nil, caller_lib = nil, paths = nil) ⇒ Object 



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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/rbbt/resource/path.rb', line 97

def find(where = nil, caller_lib = nil, paths = nil)
  @path ||= {}
  rsearch_paths = (resource and resource.respond_to?(:search_paths)) ? resource.search_paths : nil 
  key_elems = [where, caller_lib, rsearch_paths, paths]
  key = Misc.digest(key_elems.inspect)
  self.sub!('~/', Etc.getpwuid.dir + '/') if self.include? "~"
  @path[key] ||= begin
                   paths = [paths, rsearch_paths, self.search_paths, SEARCH_PATHS].reverse.compact.inject({}){|acc,h| acc.merge! h; acc }
                   where = paths[:default] if where == :default
                   return self if located?
                   if self.match(/(.*?)\/(.*)/)
                     toplevel, subpath = self.match(/(.*?)\/(.*)/).values_at 1, 2
                   else
                     toplevel, subpath = self, ""
                   end

                   path = nil
                   res = if where.nil?
                     STANDARD_SEARCH.each do |w| 
                       w = w.to_sym
                       next unless paths.include? w
                       path = find(w, caller_lib, paths)
                       return path if File.exist? path
                     end
                     (SEARCH_PATHS.keys - STANDARD_SEARCH).each do |w|
                       w = w.to_sym
                       next unless paths.include? w
                       path = find(w, caller_lib, paths)
                       return path if File.exist? path
                     end

                     if paths.include? :default
                       find((paths[:default] || :user), caller_lib, paths)
                     else
                       raise "Path '#{ path }' not found, and no default specified in search paths: #{paths.inspect}"
                     end
                   else
                     where = where.to_sym
                     raise "Did not recognize the 'where' tag: #{where}. Options: #{paths.keys}" unless paths.include? where

                     if where == :lib
                       libdir = Path.caller_lib_dir(caller_lib) || "NOLIBDIR"
                     else
                       libdir = "NOLIBDIR"
                     end
                     pwd = FileUtils.pwd
                     path = paths[where]
                     path = File.join(path, "{PATH}") unless path.include? "PATH}" or path.include? "{BASENAME}"
                     path = path.
                       sub('{PKGDIR}', pkgdir).
                       sub('{PWD}', pwd).
                       sub('{TOPLEVEL}', toplevel).
                       sub('{SUBPATH}', subpath).
                       sub('{BASENAME}', File.basename(self)).
                       sub('{PATH}', self).
                       sub('{LIBDIR}', libdir) #, @pkgdir, @resource, @search_paths

                     path = path + '.gz' if File.exist? path + '.gz'
                     path = path + '.bgz' if File.exist? path + '.bgz'

                     self.annotate path
                   end

                   res.original = self

                   res
                 end
end

#find_all(caller_lib = nil, search_paths = nil) ⇒ Object 



166
167
168
169
170
171
172
173
 
# File 'lib/rbbt/resource/path.rb', line 166

def find_all(caller_lib = nil, search_paths = nil)
  search_paths ||= self.search_paths || SEARCH_PATHS
  search_paths = search_paths.dup

  search_paths.keys.
    collect{|where| find(where, Path.caller_lib_dir, search_paths) }.
    compact.select{|file| file.exists? }.uniq
end

#glob(pattern = '*') ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/rbbt/resource/path.rb', line 43

def glob(pattern = '*')
  if self.include? "*"
    self.glob_all
  else
    return [] unless self.exists? 
    exp = File.join(self.find, pattern)
    Dir.glob(exp).collect{|f| Path.setup(f, self.resource, self.pkgdir)}
  end
end

#glob_all(caller_lib = nil, search_paths = nil) ⇒ Object 



175
176
177
178
179
180
181
182
 
# File 'lib/rbbt/resource/path.rb', line 175

def glob_all(caller_lib = nil, search_paths = nil)
  search_paths ||= self.search_paths || SEARCH_PATHS
  search_paths = search_paths.dup

  search_paths.keys.
    collect{|where| Dir.glob(find(where, Path.caller_lib_dir, search_paths))}.
    compact.flatten.uniq.collect{|path| Path.setup(path, self.resource, self.pkgdir)}
end

#identifier_file_path ⇒ Object 



299
300
301
302
303
304
305
 
# File 'lib/rbbt/resource/path.rb', line 299

def identifier_file_path
  if self.dirname.identifiers.exists?
    self.dirname.identifiers
  else
    nil
  end
end

#identifier_files ⇒ Object 



307
308
309
310
311
312
313
 
# File 'lib/rbbt/resource/path.rb', line 307

def identifier_files
  if identifier_file_path.nil?
    []
  else
    [identifier_file_path]
  end
end

#in_dir?(dir) ⇒ Boolean

{{{ Methods

Returns:

  • (Boolean) 


185
186
187
 
# File 'lib/rbbt/resource/path.rb', line 185

def in_dir?(dir)
  ! ! File.expand_path(self).match(/^#{Regexp.quote dir}/)
end

#index(options = {}) ⇒ Object 



273
274
275
 
# File 'lib/rbbt/resource/path.rb', line 273

def index(options = {})
  TSV.index(self.produce, options)
end

#join(name) ⇒ Object 



25
26
27
28
29
30
31
32
 
# File 'lib/rbbt/resource/path.rb', line 25

def join(name)
  raise "Invalid path: #{ self }" if self.nil?
  if self.empty?
    self.annotate name.to_s.dup
  else
    self.annotate File.join(self, name.to_s)
  end
end

#keys(field = 0, sep = "\t") ⇒ Object 



259
260
261
 
# File 'lib/rbbt/resource/path.rb', line 259

def keys(field = 0, sep = "\t")
  Open.read(self.produce.find).split("\n").collect{|l| next if l =~ /^#/; l.split(sep, -1)[field]}.compact
end

#list ⇒ Object 



255
256
257
 
# File 'lib/rbbt/resource/path.rb', line 255

def list
  Open.read(self.produce.find).split "\n"
end

#located? ⇒ Boolean

Returns:

  • (Boolean) 


27
28
29
 
# File 'lib/rbbt/resource/util.rb', line 27

def located?
  self.byte(0) == SLASH or (self.byte(0) == DOT and self.byte(1) == SLASH)
end

#open(options = {}, &block) ⇒ Object 



229
230
231
 
# File 'lib/rbbt/resource/path.rb', line 229

def open(options = {}, &block)
  Open.open(self.produce.find, options, &block)
end

#pipe_to(cmd, options = {}) ⇒ Object 



269
270
271
 
# File 'lib/rbbt/resource/path.rb', line 269

def pipe_to(cmd, options = {})
  CMD.cmd(cmd, {:in => self.open, :pipe => true}.merge(options))
end

#pos_index(pos, options = {}) ⇒ Object 



281
282
283
 
# File 'lib/rbbt/resource/path.rb', line 281

def pos_index(pos, options = {})
  TSV.pos_index(self.produce, pos, options)
end

#produce(force = false) ⇒ Object 



210
211
212
213
214
215
216
217
218
 
# File 'lib/rbbt/resource/path.rb', line 210

def produce(force = false)
  return self if _exists? and not force

  raise "No resource defined to produce file: #{ self }" if resource.nil?

  resource.produce self, force

  self
end

#range_index(start, eend, options = {}) ⇒ Object 



277
278
279
 
# File 'lib/rbbt/resource/path.rb', line 277

def range_index(start, eend, options = {})
  TSV.range_index(self.produce, start, eend, options)
end

#read(&block) ⇒ Object 



220
221
222
 
# File 'lib/rbbt/resource/path.rb', line 220

def read(&block)
  Open.read(self.produce.find, &block)
end

#set_extension(new_extension = nil) ⇒ Object 



315
316
317
318
 
# File 'lib/rbbt/resource/path.rb', line 315

def set_extension(new_extension = nil)
  new_path = self.sub(/\.[^\.\/]+$/, "." << new_extension.to_s)
  Path.setup new_path, @pkgdir, @resource
end

#source_for_doc_file(relative_to = 'lib') ⇒ Object 



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/rbbt/resource/path.rb', line 330

def source_for_doc_file(relative_to = 'lib')
  if located?
    lib_dir = Path.caller_lib_dir(Path.caller_lib_dir(self, 'doc'), relative_to)
    relative_file = self.sub(/(.*\/)doc\//, '\1').sub(lib_dir + "/",'')
    file = File.join(lib_dir, relative_file)

    if not File.exist?(file)
      file= Dir.glob(file.sub(/\.[^\.\/]+$/, '.*')).first
    end

    Path.setup file, @pkgdir, @resource
  else
    relative_file = self.sub(/^doc\//, '\1')

    if not File.exist?(relative_file)
      relative_file = Dir.glob(relative_file.sub(/\.[^\.\/]+$/, '.*')).first
    end

    Path.setup relative_file , @pkgdir, @resource
  end
end

#sub(*args) ⇒ Object 



17
18
19
 
# File 'lib/rbbt/resource/path.rb', line 17

def sub(*args)
  self.annotate super(*args)
end

#to_s ⇒ Object 



189
190
191
 
# File 'lib/rbbt/resource/path.rb', line 189

def to_s
  self.find
end

#to_yaml(*args) ⇒ Object 



285
286
287
 
# File 'lib/rbbt/resource/path.rb', line 285

def to_yaml(*args)
  self.to_s.to_yaml(*args)
end

#traverse(options = {}, &block) ⇒ Object 



251
252
253
 
# File 'lib/rbbt/resource/path.rb', line 251

def traverse(options = {}, &block)
  TSV::Parser.traverse(self.open, options, &block)
end

#tsv(*args) ⇒ Object 



241
242
243
 
# File 'lib/rbbt/resource/path.rb', line 241

def tsv(*args)
  TSV.open(self.produce, *args)
end

#tsv_options(options = {}) ⇒ Object 



245
246
247
248
249
 
# File 'lib/rbbt/resource/path.rb', line 245

def tsv_options(options = {})
  self.open do |stream|
    TSV::Parser.new(stream, options).options
  end
end

#write(*args, &block) ⇒ Object 



224
225
226
 
# File 'lib/rbbt/resource/path.rb', line 224

def write(*args, &block)
  Open.write(self.produce.find, *args, &block)
end

#yaml ⇒ Object 



263
264
265
266
267
 
# File 'lib/rbbt/resource/path.rb', line 263

def yaml
  self.open do |f|
    YAML.load f
  end
end