hike 1.2.3 → 2.0.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Sam Stephenson
+Copyright (c) 2014 Sam Stephenson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/hike.rb

@@ -1,8 +1,8 @@
 module Hike
   VERSION = "1.2.0"
 
+  autoload :CachedTrail,     "hike/cached_trail"
   autoload :Extensions,      "hike/extensions"
-  autoload :Index,           "hike/index"
   autoload :NormalizedArray, "hike/normalized_array"
   autoload :Paths,           "hike/paths"
   autoload :Trail,           "hike/trail"

data/lib/hike/{index.rb → cached_trail.rb}

@@ -1,22 +1,22 @@
 require 'pathname'
 
 module Hike
-  # `Index` is an internal cached variant of `Trail`. It assumes the
+  # `CachedTrail` is an internal cached variant of `Trail`. It assumes the
   # file system does not change between `find` calls. All `stat` and
-  # `entries` calls are cached for the lifetime of the `Index` object.
-  class Index
-    # `Index#paths` is an immutable `Paths` collection.
+  # `entries` calls are cached for the lifetime of the `CachedTrail` object.
+  class CachedTrail
+    # `CachedTrail#paths` is an immutable `Paths` collection.
     attr_reader :paths
 
-    # `Index#extensions` is an immutable `Extensions` collection.
+    # `CachedTrail#extensions` is an immutable `Extensions` collection.
     attr_reader :extensions
 
-    # `Index#aliases` is an immutable `Hash` mapping an extension to
+    # `CachedTrail#aliases` is an immutable `Hash` mapping an extension to
     # an `Array` of aliases.
     attr_reader :aliases
 
-    # `Index.new` is an internal method. Instead of constructing it
-    # directly, create a `Trail` and call `Trail#index`.
+    # `CachedTrail.new` is an internal method. Instead of constructing it
+    # directly, create a `Trail` and call `Trail#CachedTrail`.
     def initialize(root, paths, extensions, aliases)
       @root = root
 
@@ -35,41 +35,48 @@ module Hike
       @patterns = {}
     end
 
-    # `Index#root` returns root path as a `String`. This attribute is immutable.
+    # `CachedTrail#root` returns root path as a `String`. This attribute is immutable.
     def root
       @root.to_s
     end
 
-    # `Index#index` returns `self` to be compatable with the `Trail` interface.
-    def index
+    # `CachedTrail#cached` returns `self` to be compatable with the `Trail` interface.
+    def cached
       self
     end
 
+    # Deprecated alias for `cached`.
+    alias_method :index, :cached
+
     # The real implementation of `find`. `Trail#find` generates a one
-    # time index and delegates here.
+    # time cache and delegates here.
     #
     # See `Trail#find` for usage.
-    def find(*logical_paths, &block)
-      if block_given?
-        options = extract_options!(logical_paths)
-        base_path = Pathname.new(options[:base_path] || @root)
-
-        logical_paths.each do |logical_path|
-          logical_path = Pathname.new(logical_path.sub(/^\//, ''))
-
-          if relative?(logical_path)
-            find_in_base_path(logical_path, base_path, &block)
-          else
-            find_in_paths(logical_path, &block)
-          end
-        end
+    def find(*logical_paths)
+      find_all(*logical_paths).first
+    end
 
-        nil
-      else
-        find(*logical_paths) do |path|
-          return path
+    # The real implementation of `find_all`. `Trail#find_all` generates a one
+    # time index and delegates here.
+    #
+    # See `Trail#find_all` for usage.
+    def find_all(*logical_paths, &block)
+      return to_enum(__method__, *logical_paths) unless block_given?
+
+      options = extract_options!(logical_paths)
+      base_path = Pathname.new(options[:base_path] || @root)
+
+      logical_paths.each do |logical_path|
+        logical_path = Pathname.new(logical_path.sub(/^\//, ''))
+
+        if relative?(logical_path)
+          find_in_base_path(logical_path, base_path, &block)
+        else
+          find_in_paths(logical_path, &block)
         end
       end
+
+      nil
     end
 
     # A cached version of `Dir.entries` that filters out `.` files and

data/lib/hike/trail.rb

@@ -1,6 +1,6 @@
 require 'pathname'
+require 'hike/cached_trail'
 require 'hike/extensions'
-require 'hike/index'
 require 'hike/paths'
 
 module Hike
@@ -28,7 +28,7 @@ module Hike
     # allows you to require files with specifiying `foo.rb`.
     attr_reader :extensions
 
-    # `Index#aliases` is a mutable `Hash` mapping an extension to
+    # `Trail#aliases` is a mutable `Hash` mapping an extension to
     # an `Array` of aliases.
     #
     #   trail = Hike::Trail.new
@@ -123,39 +123,46 @@ module Hike
     #
     #     trail.find("hike") || trail.find("hike/index")
     #
-    # Though `find` always returns the first match, it is possible
-    # to iterate over all shadowed matches and fallbacks by supplying
-    # a block.
+    def find(*args)
+      index.find(*args)
+    end
+
+    # `Trail#find_all` returns all matching paths including fallbacks and
+    #  shadowed matches.
     #
-    #     trail.find("hike", "hike/index") { |path| warn path }
+    #     trail.find_all("hike", "hike/index").each { |path| warn path }
     #
-    # This allows you to filter your matches by any condition.
+    # `find_all` returns an `Enumerator`. This allows you to filter your
+    # matches by any condition.
     #
-    #     trail.find("application") do |path|
-    #       return path if mime_type_for(path) == "text/css"
+    #     trail.find_all("application").find do |path|
+    #       mime_type_for(path) == "text/css"
     #     end
     #
-    def find(*args, &block)
-      index.find(*args, &block)
+    def find_all(*args, &block)
+      cached.find_all(*args, &block)
     end
 
-    # `Trail#index` returns an `Index` object that has the same
-    # interface as `Trail`. An `Index` is a cached `Trail` object that
+    # `Trail#cached` returns an `CachedTrail` object that has the same
+    # interface as `Trail`. An `CachedTrail` is a cached `Trail` object that
     # does not update when the file system changes. If you are
     # confident that you are not making changes the paths you are
-    # searching, `index` will avoid excess system calls.
+    # searching, `cached` will avoid excess system calls.
     #
-    #     index = trail.index
-    #     index.find "hike/trail"
-    #     index.find "test_trail"
+    #     cached = trail.cached
+    #     cached.find "hike/trail"
+    #     cached.find "test_trail"
     #
-    def index
-      Index.new(root, paths, extensions, aliases)
+    def cached
+      CachedTrail.new(root, paths, extensions, aliases)
     end
 
+    # Deprecated alias for `cached`.
+    alias_method :index, :cached
+
     # `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`.
+    # parity with `CachedTrail#entries`.
     def entries(path)
       pathname = Pathname.new(path)
       if pathname.directory?
@@ -167,7 +174,7 @@ module Hike
 
     # `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`.
+    # parity with `CachedTrail#stat`.
     def stat(path)
       if File.exist?(path)
         File.stat(path.to_s)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hike
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -36,8 +36,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - LICENSE
+- lib/hike/cached_trail.rb
 - lib/hike/extensions.rb
-- lib/hike/index.rb
 - lib/hike/normalized_array.rb
 - lib/hike/paths.rb
 - lib/hike/trail.rb
@@ -54,7 +54,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: