hike 1.1.0 → 1.2.0

data/LICENSE

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

data/README.md

@@ -9,8 +9,8 @@ implement search paths, load paths, and the like.
 Find Ruby files in this project:
 
     trail = Hike::Trail.new "/Users/sam/Projects/hike"
-    trail.extensions.push ".rb"
-    trail.paths.push "lib", "test"
+    trail.append_extension ".rb"
+    trail.append_paths "lib", "test"
 
     trail.find "hike/trail"
     # => "/Users/sam/Projects/hike/lib/hike/trail.rb"
@@ -21,8 +21,8 @@ Find Ruby files in this project:
 Explore your Ruby load path:
 
     trail = Hike::Trail.new "/"
-    trail.extensions.push ".rb", ".bundle"
-    trail.paths.replace $:
+    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"
@@ -33,7 +33,7 @@ Explore your Ruby load path:
 Explore your shell path:
 
     trail = Hike::Trail.new "/"
-    trail.paths.replace ENV["PATH"].split(":")
+    trail.append_paths *ENV["PATH"].split(":")
 
     trail.find "ls"
     # => "/bin/ls"
@@ -47,6 +47,6 @@ Explore your shell path:
 
 # License
 
-Copyright (c) 2010 Sam Stephenson.
+Copyright (c) 2011 Sam Stephenson.
 
 Released under the MIT license. See `LICENSE` for details.

data/lib/hike.rb

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

data/lib/hike/index.rb

@@ -11,16 +11,23 @@ module Hike
     # `Index#extensions` is an immutable `Extensions` collection.
     attr_reader :extensions
 
+    # `Index#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`.
-    def initialize(root, paths, extensions)
+    def initialize(root, paths, extensions, aliases)
       @root = root
 
       # Freeze is used here so an error is throw if a mutator method
-      # is called on the array. Mutating `@paths` or `@extensions`
-      # would have unpredictable results.
+      # is called on the array. Mutating `@paths`, `@extensions`, or
+      # `@aliases` would have unpredictable results.
       @paths      = paths.dup.freeze
       @extensions = extensions.dup.freeze
+      @aliases    = aliases.inject({}) { |h, (k, a)|
+                      h[k] = a.dup.freeze; h
+                   }.freeze
       @pathnames  = paths.map { |path| Pathname.new(path) }
 
       @stats    = {}
@@ -65,11 +72,12 @@ module Hike
       end
     end
 
-    # A cached version of `Dir.entries` that filters out `.` and
-    # `..`. Returns an empty `Array` if the directory does not exist.
+    # A cached version of `Dir.entries` that filters out `.` files and
+    # `~` swap files. 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 =~ /^\.\.?$/ }
+      @entries[key] ||= Pathname.new(path).entries.reject { |entry| entry.to_s =~ /^\.|~$|^\#.*\#$/ }
     rescue Errno::ENOENT
       @entries[key] = []
     end
@@ -141,23 +149,55 @@ module Hike
         paths.any? { |path| dirname.to_s[0, path.length] == path }
       end
 
+      # Cache results of `build_pattern_for`
+      def pattern_for(basename)
+        @patterns[basename] ||= build_pattern_for(basename)
+      end
+
       # Returns a `Regexp` that matches the allowed extensions.
       #
-      #     pattern_for("index.html") #=> /^index.html(.builder|.erb)+$/
-      def pattern_for(basename)
-        @patterns[basename] ||= begin
-          extension_pattern = extensions.map { |e| Regexp.escape(e) }.join("|")
-          /^#{Regexp.escape(basename.to_s)}(?:#{extension_pattern}|)+$/
+      #     pattern_for("index.html") #=> /^index(.html|.htm)(.builder|.erb)*$/
+      def build_pattern_for(basename)
+        extname = basename.extname
+        aliases = find_aliases_for(extname)
+
+        if aliases.any?
+          basename = basename.basename(extname)
+          aliases  = [extname] + aliases
+          aliases_pattern = aliases.map { |e| Regexp.escape(e) }.join("|")
+          basename_re = Regexp.escape(basename.to_s) + "(?:#{aliases_pattern})"
+        else
+          basename_re = Regexp.escape(basename.to_s)
         end
+
+        extension_pattern = extensions.map { |e| Regexp.escape(e) }.join("|")
+        /^#{basename_re}(?:#{extension_pattern})*$/
       end
 
       # Sorts candidate matches by their extension
       # priority. Extensions in the front of the `extensions` carry
       # more weight.
       def sort_matches(matches, basename)
+        aliases = find_aliases_for(basename.extname)
+
         matches.sort_by do |match|
-          extnames = match.to_s[basename.to_s.length..-1].scan(/.[^.]+/)
-          extnames.inject(0) { |sum, ext| sum + extensions.index(ext) + 1 }
+          extnames = match.sub(basename.to_s, '').to_s.scan(/\.[^.]+/)
+          extnames.inject(0) do |sum, ext|
+            if i = extensions.index(ext)
+              sum + i + 1
+            elsif i = aliases.index(ext)
+              sum + i + 11
+            else
+              sum
+            end
+          end
+        end
+      end
+
+      def find_aliases_for(extension)
+        @aliases.inject([]) do |aliases, (key, value)|
+          aliases.push(key) if value == extension
+          aliases
         end
       end
   end

data/lib/hike/trail.rb

@@ -28,6 +28,20 @@ module Hike
     # allows you to require files with specifiying `foo.rb`.
     attr_reader :extensions
 
+    # `Index#aliases` is a mutable `Hash` mapping an extension to
+    # an `Array` of aliases.
+    #
+    #   trail = Hike::Trail.new
+    #   trail.paths.push "~/Projects/hike/site"
+    #   trail.aliases['.htm']   = 'html'
+    #   trail.aliases['.xhtml'] = 'html'
+    #   trail.aliases['.php']   = 'html'
+    #
+    # Aliases provide a fallback when the primary extension is not
+    # matched. In the example above, a lookup for "foo.html" will
+    # check for the existence of "foo.htm", "foo.xhtml", or "foo.php".
+    attr_reader :aliases
+
     # A Trail accepts an optional root path that defaults to your
     # current working directory. Any relative paths added to
     # `Trail#paths` will expanded relative to the root.
@@ -35,6 +49,7 @@ module Hike
       @root       = Pathname.new(root).expand_path
       @paths      = Paths.new(@root)
       @extensions = Extensions.new
+      @aliases    = Hash.new { |h, k| h[k] = Extensions.new }
     end
 
     # `Trail#root` returns root path as a `String`. This attribute is immutable.
@@ -42,6 +57,50 @@ module Hike
       @root.to_s
     end
 
+    # Prepend `path` to `Paths` collection
+    def prepend_paths(*paths)
+      self.paths.unshift(*paths)
+    end
+    alias_method :prepend_path, :prepend_paths
+
+    # Append `path` to `Paths` collection
+    def append_paths(*paths)
+      self.paths.push(*paths)
+    end
+    alias_method :append_path, :append_paths
+
+    # Remove `path` from `Paths` collection
+    def remove_path(path)
+      self.paths.delete(path)
+    end
+
+    # Prepend `extension` to `Extensions` collection
+    def prepend_extensions(*extensions)
+      self.extensions.unshift(*extensions)
+    end
+    alias_method :prepend_extension, :prepend_extensions
+
+    # Append `extension` to `Extensions` collection
+    def append_extensions(*extensions)
+      self.extensions.push(*extensions)
+    end
+    alias_method :append_extension, :append_extensions
+
+    # Remove `extension` from `Extensions` collection
+    def remove_extension(extension)
+      self.extensions.delete(extension)
+    end
+
+    # Alias `new_extension` to `old_extension`
+    def alias_extension(new_extension, old_extension)
+      aliases[normalize_extension(new_extension)] = normalize_extension(old_extension)
+    end
+
+    # Remove the alias for `extension`
+    def unalias_extension(extension)
+      aliases.delete(normalize_extension(extension))
+    end
+
     # `Trail#find` returns a the expand path for a logical path in the
     # path collection.
     #
@@ -91,7 +150,7 @@ module Hike
     #     index.find "test_trail"
     #
     def index
-      Index.new(root, paths, extensions)
+      Index.new(root, paths, extensions, aliases)
     end
 
     # `Trail#entries` is equivalent to `Dir#entries`. It is not
@@ -107,5 +166,14 @@ module Hike
     def stat(*args)
       index.stat(*args)
     end
+
+    private
+      def normalize_extension(extension)
+        if extension[/^\./]
+          extension
+        else
+          ".#{extension}"
+        end
+      end
   end
 end

metadata

@@ -1,34 +1,24 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: hike
-version: !ruby/object:Gem::Version 
-  hash: 19
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Sam Stephenson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-14 00:00:00 -05:00
+date: 2011-07-18 00:00:00.000000000 -05:00
 default_executable: 
 dependencies: []
-
 description: A Ruby library for finding files in a set of paths.
-email: 
+email:
 - sstephenson@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - LICENSE
 - lib/hike/extensions.rb
@@ -40,36 +30,26 @@ files:
 has_rdoc: true
 homepage: http://github.com/sstephenson/hike
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Find files in a set of paths
 test_files: []
-