pathological 0.2.5 → 0.2.6

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"

data/README.md

@@ -1,10 +1,10 @@
-Pathological
-============
+# Pathological
 
 Pathological is a Ruby tool that provides a lightweight mechanism for managing your project's load path.
 
-The problem
------------
+[![Build Status](https://secure.travis-ci.org/ooyala/pathological.png)](http://travis-ci.org/ooyala/pathological)
+
+## The problem
 
 When you're writing a gem, you don't have to worry about paths much, because Rubygems makes sure that `lib/`
 makes it into your path for you. On the other hand, if you have large Ruby projects which aren't organized as
@@ -22,8 +22,7 @@ gems, you may encounter some of the following problems:
 
 Pathological provides one way to manage these issues.
 
-Using pathological
-------------------
+## Using pathological
 
 Getting started with pathological is easy. First, make a file called `Pathfile` at your project root:
 
@@ -51,8 +50,7 @@ Pathological (and of course you should have `gem "pathological"` in your `Gemfil
 
 `Pathfile`s should be kept in version control.
 
-Adding other paths to your load path
-------------------------------------
+## Adding other paths to your load path
 
 To add more paths to your load path, just put the paths in your `Pathfile`. The paths are relative to the
 location of the `Pathfile`. The paths will be inserted in the order they appear; the project root itself will
@@ -84,15 +82,13 @@ require "common"
 # ...
 ```
 
-Installation
-------------
+## Installation
 
 Pathological is packaged as a Rubygem and hence can be trivially installed with
 
     $ gem install pathological
 
-Advanced usage
---------------
+## Advanced usage
 
 In some cases, you might want slightly different behavior. This customization is done through the use of
 custom modes. You may use any combination of modes.
@@ -139,11 +135,10 @@ A quicker way is also provided: if you only need to use one special mode, then t
 can require:
 
 ``` ruby
-require "pathological/bundlerize"
+require "pathological/debug"
 ```
 
-Public API
-----------
+## Public API
 
 For even more configurable custom integration with Pathological, a public API is provided. See the generated
 documentation for details on the following public methods:
@@ -154,8 +149,26 @@ documentation for details on the following public methods:
 * `Pathological#reset!`
 * `Pathological#copy_outside_paths!`
 
-Authors
--------
+## Notes and gotchas
+
+Pathological is intended as a replacement for manually munging the load path in your application when you want
+to load code from other locations. If you can turn each of your dependencies into a gem and then use bundler
+to manage the dependencies, **do that instead**.
+
+Pathological does its best to figure out where the Pathfile it should use is located, based on the call stack.
+For instance, if you run `/foo/bar.rb` and that requires Pathological, then it will search for `/foo/Pathfile`
+and -- failing that -- `/Pathfile`. However, if `/foo/bar.rb` does not require Pathological, but loads a ruby
+file in `/baz/quux.rb`, and *that* file requires Pathological, then Pathological searches for `/baz/Pathfile`
+and then `/Pathfile`.
+
+Any code loading situation which does not preserve a sane load path will be incompatible with Pathological.
+For instance, if you `eval()` some code that requires Pathological, Pathological has no way of telling where
+that code originally lived, and will probably behave in an unexpected way. One place this commonly occurs is
+with rack webservers (e.g., Rackup, Unicorn) that load a `config.ru`. This file is `instance_eval`ed and so
+requiring Pathological from your `config.ru` will not work as expected. In these cases, require Pathological
+in your app directly.
+
+## Authors
 
 Pathological was written by the following Ooyala engineers:
 
@@ -164,25 +177,21 @@ Pathological was written by the following Ooyala engineers:
 * [Sami Abu-El-Haija](mailto:sami@ooyala.com)
 * [Evan Chan](mailto:ev@ooyala.com)
 
-Credits
--------
+## Credits
 
 * Harry Robertson for the idea to *not* use a dot-prefixed configuration file
 
-Metadata
---------
+## Metadata
 
 * [Hosted on Github](https://github.com/ooyala/pathological)
 * [Rubygems page](https://rubygems.org/gems/pathological)
 * [Documentation](http://rubydoc.info/github/ooyala/pathological/master/frames)
 
-Contributing
-------------
+## Contributing
 
 If you would like to commit a patch, great! Just do the usual github pull request stuff and we'll check it
 out[.](http://www.randomkittengenerator.com/)
 
-License
--------
+## License
 
 Pathological is licensed under the MIT license.

data/Rakefile

@@ -12,3 +12,4 @@ namespace :test do
   end
 end
 
+task :default => ["test:units"]

data/lib/pathological/base.rb

@@ -234,17 +234,20 @@ module Pathological
 
   # Searches the call stack for the file that required pathological. If no file can be found, falls back to
   # the currently executing file ($0). This handles the case where the app was launched by another executable
-  # (rake, thin, rackup, etc.)
+  # (rake, thin, etc.)
   #
   # @return [String] name of file requiring pathological, or the currently executing file.
   def self.requiring_filename
+    # Match paths like .../gems/pathological-0.2.2.1/lib/pathological/base.rb and also
+    # .../gems/pathological-0.2.2.1/lib/pathological.rb
+    pathological_file_pattern = %r{/pathological(/[^/]+|)\.rb}
     requiring_file = Kernel.caller.find do |stack_line|
       if RUBY_VERSION.start_with?("1.9")
         # In Ruby 1.9, top-level files will have the string "top (required)" included in the stack listing.
-        stack_line.include?("top (required)") && !stack_line.include?("pathological.rb")
+        stack_line.include?("top (required)") && stack_line !~ pathological_file_pattern
       else
         # In Ruby 1.8, top-level files are listed with their relative path and without a line number.
-        !stack_line.match(/:\d+:in/) && !stack_line.include?("pathological.rb")
+        stack_line !~ /:\d+:in/ && stack_line !~ pathological_file_pattern
       end
     end
     requiring_file ? requiring_file.match(/(.+):\d+/)[1] : $0 rescue $0

data/lib/pathological/version.rb

@@ -1,3 +1,3 @@
 module Pathological
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/test/unit/pathological/base_test.rb

@@ -102,7 +102,7 @@ module Pathological
 
       context "#requiring_filename" do
         setup do
-          @full_stacktrace = %Q{
+          @full_19_stacktrace = %Q{
 /Users/test/ruby/gems/1.9.1/gems/pathological-0.2.2.1/lib/pathological/base.rb:61:in `find_pathfile'
 /Users/test/gems/pathological-0.2.2.1/lib/pathological/base.rb:36:in `find_load_paths'
 /Users/test/gems/pathological-0.2.2.1/lib/pathological/base.rb:15:in `add_paths!'
@@ -112,15 +112,28 @@ module Pathological
 /Users/test/ruby/1.9.1/rubygems/custom_require.rb:35:in `require'
 /Users/test/repos/pathological/test/rackup/app.rb:1:in `<top (required)>'
 /Users/test/.rubies/1.9.2-p290/lib/ruby/site_ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
-          }.split("\n")
+          }.split("\n").reject(&:empty?)
+          @full_18_stacktrace = %Q{
+/Users/test/ruby/gems/1.8/gems/pathological-0.2.5/lib/pathological/base.rb:61:in `find_pathfile'
+/Users/test/ruby/gems/1.8/gems/pathological-0.2.5/lib/pathological/base.rb:36:in `find_load_paths'
+/Users/test/ruby/gems/1.8/gems/pathological-0.2.5/lib/pathological/base.rb:15:in `add_paths!'
+/Users/test/ruby/gems/1.8/gems/pathological-0.2.5/lib/pathological.rb:3
+/Users/test/ruby/site_ruby/1.8/rubygems/custom_require.rb:58:in `gem_original_require'
+/Users/test/ruby/site_ruby/1.8/rubygems/custom_require.rb:58:in `require'
+app.rb:2
+          }.split("\n").reject(&:empty?)
           @bad_stacktrace = %Q{
 /Users/test/repos/pathological/test/rackup/app.rb !!! `<top (required)>'
-          }.split("\n")
+          }.split("\n").reject(&:empty?)
           @empty_stacktrace = []
         end
 
         should "find root file from a stacktrace" do
-          stub(Kernel).caller { @full_stacktrace }
+          if RUBY_VERSION.start_with?("1.9")
+            stub(Kernel).caller { @full_19_stacktrace }
+          else
+            stub(Kernel).caller { @full_18_stacktrace }
+          end
           assert_equal "app.rb", File.basename(Pathological.requiring_filename)
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pathological
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000Z
+date: 2012-09-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &27117160 !ruby/object:Gem::Requirement
+  requirement: &19178940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *27117160
+  version_requirements: *19178940
 - !ruby/object:Gem::Dependency
   name: scope
-  requirement: &27091120 !ruby/object:Gem::Requirement
+  requirement: &19178380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: 0.2.3
   type: :development
   prerelease: false
-  version_requirements: *27091120
+  version_requirements: *19178380
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &27090740 !ruby/object:Gem::Requirement
+  requirement: &19177920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27090740
+  version_requirements: *19177920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &27090280 !ruby/object:Gem::Requirement
+  requirement: &19171820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,7 +56,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27090280
+  version_requirements: *19171820
 description: ! "    Pathological provides a way to manage a project's require paths
   by using a small config file that\n    indicates all directories to include in the
   load path.\n"
@@ -68,9 +68,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
 - .yardopts
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,24 +0,0 @@
-PATH
-  remote: .
-  specs:
-    pathological (0.2.5)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    fakefs (0.4.0)
-    minitest (2.5.1)
-    rake (0.9.2.2)
-    rr (1.0.3)
-    scope (0.2.3)
-      minitest
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fakefs
-  pathological!
-  rake
-  rr (>= 1.0.3)
-  scope (>= 0.2.3)