hike 1.0.0 → 1.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Sam Stephenson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,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.extensions.push ".rb"
+    trail.paths.push "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.extensions.push ".rb", ".bundle"
+    trail.paths.replace $:
+
+    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.paths.replace 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) 2010 Sam Stephenson.
+
+Released under the MIT license. See `LICENSE` for details.

data/lib/hike.rb

@@ -1,5 +1,5 @@
 module Hike
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 
   autoload :Extensions,      "hike/extensions"
   autoload :Index,           "hike/index"

data/lib/hike/index.rb

@@ -65,6 +65,30 @@ module Hike
       end
     end
 
+    # A cached version of `Dir.entries` that filters out `.` and
+    # `..`. Returns an empty `Array` if the directory does not exist.
+    def entries(path)
+      key = path.to_s
+      @entries[key] ||= Pathname.new(path).entries.reject { |entry| entry.to_s =~ /^\.\.?$/ }
+    rescue Errno::ENOENT
+      @entries[key] = []
+    end
+
+    # A cached version of `File.stat`. Returns nil if the file does
+    # not exist.
+    def stat(path)
+      key = path.to_s
+      if @stats.key?(key)
+        @stats[key]
+      else
+        begin
+          @stats[key] = File.stat(path)
+        rescue Errno::ENOENT
+          @stats[key] = nil
+        end
+      end
+    end
+
     protected
       def extract_options!(arguments)
         arguments.last.is_a?(Hash) ? arguments.pop.dup : {}
@@ -112,28 +136,6 @@ module Hike
         end
       end
 
-      # A cached version of `File.stat`. Returns nil if the file does
-      # not exist.
-      def stat(pathname)
-        if @stats.key?(pathname)
-          @stats[pathname]
-        else
-          begin
-            @stats[pathname] = pathname.stat
-          rescue Errno::ENOENT
-            @stats[pathname] = nil
-          end
-        end
-      end
-
-      # A cached version of `Dir.entries` that filters out `.` and
-      # `..`. Returns an empty `Array` if the directory does not exist.
-      def entries(pathname)
-        @entries[pathname] ||= pathname.entries.reject { |entry| entry.to_s =~ /^\.\.?$/ }
-      rescue Errno::ENOENT
-        @entries[pathname] = []
-      end
-
       # Returns true if `dirname` is a subdirectory of any of the `paths`
       def paths_contain?(dirname)
         paths.any? { |path| dirname.to_s[0, path.length] == path }

data/lib/hike/trail.rb

@@ -93,5 +93,19 @@ module Hike
     def index
       Index.new(root, paths, extensions)
     end
+
+    # `Trail#entries` is equivalent to `Dir#entries`. It is not
+    # recommend to use this method for general purposes. It exists for
+    # parity with `Index#entries`.
+    def entries(*args)
+      index.entries(*args)
+    end
+
+    # `Trail#stat` is equivalent to `File#stat`. It is not
+    # recommend to use this method for general purposes. It exists for
+    # parity with `Index#stat`.
+    def stat(*args)
+      index.stat(*args)
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: hike
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Sam Stephenson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-28 00:00:00 -05:00
+date: 2011-06-14 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +29,8 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
+- LICENSE
 - lib/hike/extensions.rb
 - lib/hike/index.rb
 - lib/hike/normalized_array.rb