Module: Path

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

Constant Summary collapse

SEARCH_PATHS = 
{
  :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}"),
  :lib     => File.join('{LIBDIR}', "{TOPLEVEL}", "{SUBPATH}"),
  :default => :user
}
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 



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/rbbt/resource/path.rb', line 50

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

#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

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
 
# 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.exists? File.join(file, relative_to)

  while file != '/'
    dir = File.dirname file
    return Path.setup(dir) if File.exists? File.join(dir, relative_to)
    file = File.dirname file
  end

  return nil
end

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



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

def self.setup(string, pkgdir = nil, resource = nil)
  string.extend Path
  string.pkgdir = pkgdir || 'rbbt'
  string.resource = resource
  string
end

Instance Method Details

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



41
42
43
44
 
# File 'lib/rbbt/resource/path.rb', line 41

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

#all_fields ⇒ Object 



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

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

#annotate(name) ⇒ Object 



14
15
16
 
# File 'lib/rbbt/resource/path.rb', line 14

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

#basename ⇒ Object 



175
176
177
 
# File 'lib/rbbt/resource/path.rb', line 175

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

#byte(pos) ⇒ Object 



46
47
48
 
# File 'lib/rbbt/resource/path.rb', line 46

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

#directory? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
 
# File 'lib/rbbt/resource/path.rb', line 30

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

#dirname ⇒ Object 



26
27
28
 
# File 'lib/rbbt/resource/path.rb', line 26

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

#doc_file(relative_to = 'lib') ⇒ Object 



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

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) 


137
138
139
140
141
142
143
144
 
# File 'lib/rbbt/resource/path.rb', line 137

def exists?
  begin
    self.produce
    File.exists? self.find
  rescue
    false
  end
end

#fields ⇒ Object 



215
216
217
 
# File 'lib/rbbt/resource/path.rb', line 215

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

#filename ⇒ Object 



133
134
135
 
# File 'lib/rbbt/resource/path.rb', line 133

def filename
  self.find
end

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rbbt/resource/path.rb', line 80

def find(where = nil, caller_lib = nil, search_paths = nil)
  where = search_paths[:default] if where == :default
  search_paths ||= SEARCH_PATHS
  return self if located?
  if self.match(/(.*?)\/(.*)/)
    toplevel, subpath = self.match(/(.*?)\/(.*)/).values_at 1, 2
  else
    toplevel, subpath = self, ""
  end

  path = nil
  if where.nil?
    %w(current user local global lib).each do |w| 
      w = w.to_sym
      next unless search_paths.include? w
      path = find(w, caller_lib, search_paths)
      return path if File.exists? path
    end
    if search_paths.include? :default
      find((search_paths[:default] || :user), caller_lib, search_paths)
    else
      raise "Path '#{ path }' not found, and no default specified in search paths: #{search_paths.inspect}"
    end
  else
    where = where.to_sym
    raise "Did not recognize the 'where' tag: #{where}. Options: #{search_paths.keys}" unless search_paths.include? where
    libdir = where == :lib ? Path.caller_lib_dir(caller_lib) : ""
    libdir ||= ""
    pwd = FileUtils.pwd
    Path.setup search_paths[where].sub('{PKGDIR}', pkgdir).sub('{PWD}', pwd).sub('{TOPLEVEL}', toplevel).sub('{SUBPATH}', subpath).sub('{LIBDIR}', libdir), @pkgdir, @resource
  end
end

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



113
114
115
116
117
118
119
120
121
 
# File 'lib/rbbt/resource/path.rb', line 113

def find_all(caller_lib = nil, search_paths = nil)
  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 



35
36
37
38
39
 
# File 'lib/rbbt/resource/path.rb', line 35

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

#identifier_file_path ⇒ Object 



223
224
225
226
227
228
229
 
# File 'lib/rbbt/resource/path.rb', line 223

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

#identifier_files ⇒ Object 



231
232
233
234
235
236
237
 
# File 'lib/rbbt/resource/path.rb', line 231

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

#in_dir?(dir) ⇒ Boolean

{{{ Methods

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/rbbt/resource/path.rb', line 125

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

#index(options = {}) ⇒ Object 



199
200
201
 
# File 'lib/rbbt/resource/path.rb', line 199

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

#join(name) ⇒ Object 



18
19
20
21
22
23
24
 
# File 'lib/rbbt/resource/path.rb', line 18

def join(name)
  if self.empty?
    self.annotate name.to_s
  else
    self.annotate File.join(self, name.to_s)
  end
end

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



187
188
189
 
# File 'lib/rbbt/resource/path.rb', line 187

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 



183
184
185
 
# File 'lib/rbbt/resource/path.rb', line 183

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

#located? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/rbbt/resource/util.rb', line 25

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

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



167
168
169
 
# File 'lib/rbbt/resource/path.rb', line 167

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

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



195
196
197
 
# File 'lib/rbbt/resource/path.rb', line 195

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

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



207
208
209
 
# File 'lib/rbbt/resource/path.rb', line 207

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

#produce(force = false) ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/rbbt/resource/path.rb', line 146

def produce(force = false)
  path = self.find

  return self if Open.exists?(path.to_s) 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 



203
204
205
 
# File 'lib/rbbt/resource/path.rb', line 203

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

#read(&block) ⇒ Object 



158
159
160
 
# File 'lib/rbbt/resource/path.rb', line 158

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

#set_extension(new_extension = nil) ⇒ Object 



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

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 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/rbbt/resource/path.rb', line 254

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.exists?(file)
      file= Dir.glob(file.sub(/\.[^\.\/]+$/, '.*')).first
    end

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

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

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

#to_s ⇒ Object 



129
130
131
 
# File 'lib/rbbt/resource/path.rb', line 129

def to_s
  self.find
end

#to_yaml(*args) ⇒ Object 



211
212
213
 
# File 'lib/rbbt/resource/path.rb', line 211

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

#tsv(*args) ⇒ Object 



179
180
181
 
# File 'lib/rbbt/resource/path.rb', line 179

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

#write(*args, &block) ⇒ Object 



162
163
164
 
# File 'lib/rbbt/resource/path.rb', line 162

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

#yaml ⇒ Object 



191
192
193
 
# File 'lib/rbbt/resource/path.rb', line 191

def yaml
  YAML.load self.open
end