File: README.md

package info (click to toggle)
ruby-hike 1.2.1-3.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid, trixie
  • size: 92 kB
  • sloc: ruby: 280; makefile: 2
file content (52 lines) | stat: -rw-r--r-- 1,208 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Hike
====

Hike is a Ruby library for finding files in a set of paths. Use it to
implement search paths, load paths, and the like.

# Examples

Find Ruby files in this project:

    trail = Hike::Trail.new "/Users/sam/Projects/hike"
    trail.append_extension ".rb"
    trail.append_paths "lib", "test"

    trail.find "hike/trail"
    # => "/Users/sam/Projects/hike/lib/hike/trail.rb"

    trail.find "test_trail"
    # => "/Users/sam/Projects/hike/test/test_trail.rb"

Explore your Ruby load path:

    trail = Hike::Trail.new "/"
    trail.append_extensions ".rb", ".bundle"
    trail.append_paths *$:

    trail.find "net/http"
    # => "/Users/sam/.rvm/rubies/ree-1.8.7-2010.02/lib/ruby/1.8/net/http.rb"

    trail.find "strscan"
    # => "/Users/sam/.rvm/rubies/ree-1.8.7-2010.02/lib/ruby/1.8/i686-darwin10.4.0/strscan.bundle"

Explore your shell path:

    trail = Hike::Trail.new "/"
    trail.append_paths *ENV["PATH"].split(":")

    trail.find "ls"
    # => "/bin/ls"

    trail.find "gem"
    # => "/Users/sam/.rvm/rubies/ree-1.8.7-2010.02/bin/gem"

# Installation

    $ gem install hike

# License

Copyright (c) 2011 Sam Stephenson.

Released under the MIT license. See `LICENSE` for details.