pathological 0.2.4 → 0.2.5

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    pathological (0.2.3)
+    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
@@ -18,5 +19,6 @@ PLATFORMS
 DEPENDENCIES
   fakefs
   pathological!
+  rake
   rr (>= 1.0.3)
   scope (>= 0.2.3)

data/README.md

@@ -32,16 +32,23 @@ Getting started with pathological is easy. First, make a file called `Pathfile`
 
 Now require the gem at the start of any executable ruby file:
 
-    #!/usr/bin/env ruby
+``` ruby
+#!/usr/bin/env ruby
 
-    require "rubygems" # If you're using 1.8
-    require "pathological"
-    # other requires...
+require "bundler/setup" # If you're using bundler
+require "pathological"
+
+# other requires...
+```
 
 Now your project root will be in your load path. If your project has, for example, `lib/foo.rb`, then `require
 lib/foo` will work in any of your ruby files. This works because when Pathological is required it will search
 up the directory tree until it finds a `Pathfile`. (It will raise an error if one cannot be found).
 
+Note that Pathological should be the first require in your main file so that it will be loaded first. An
+exception to this is when you're using Bundler, in which case you should `require bundler/setup` before
+Pathological (and of course you should have `gem "pathological"` in your `Gemfile`).
+
 `Pathfile`s should be kept in version control.
 
 Adding other paths to your load path
@@ -70,11 +77,12 @@ and that `Pathfile` contains the following:
 
 Then inside `run_my_project.rb`:
 
-    require "rubygems"
-    require "pathological"
-    require "foo"
-    require "common"
-    # ...
+``` ruby
+require "pathological"
+require "foo"
+require "common"
+# ...
+```
 
 Installation
 ------------
@@ -120,15 +128,19 @@ should be avoided if possible.
 
 There are two ways to specify modes. First, you can enable any modes you want using the Pathological API:
 
-    require "pathological/base"
-    Pathological.debug_mode
-    Pathological.parentdir_mode
-    Pathological.add_paths!
+``` ruby
+require "pathological/base"
+Pathological.debug_mode
+Pathological.parentdir_mode
+Pathological.add_paths!
+```
 
 A quicker way is also provided: if you only need to use one special mode, then there is a dedicated file you
 can require:
 
-    require "pathological/bundlerize"
+``` ruby
+require "pathological/bundlerize"
+```
 
 Public API
 ----------
@@ -136,10 +148,11 @@ 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:
 
-    Pathological#add_paths!
-    Pathological#find_load_paths
-    Pathological#find_pathfile
-    Pathological#reset!
+* `Pathological#add_paths!`
+* `Pathological#find_load_paths`
+* `Pathological#find_pathfile`
+* `Pathological#reset!`
+* `Pathological#copy_outside_paths!`
 
 Authors
 -------
@@ -149,6 +162,7 @@ Pathological was written by the following Ooyala engineers:
 * [Daniel MacDougall](mailto:dmac@ooyala.com)
 * [Caleb Spare](mailto:caleb@ooyala.com)
 * [Sami Abu-El-Haija](mailto:sami@ooyala.com)
+* [Evan Chan](mailto:ev@ooyala.com)
 
 Credits
 -------

data/Rakefile

@@ -1,2 +1,14 @@
 require "bundler"
+require "rake/testtask"
+
 Bundler::GemHelper.install_tasks
+
+task :test => ["test:units"]
+
+namespace :test do
+  Rake::TestTask.new(:units) do |task|
+    task.libs << "test"
+    task.test_files = FileList["test/unit/**/*_test.rb"]
+  end
+end
+

data/lib/pathological/base.rb

@@ -76,6 +76,57 @@ module Pathological
     end
   end
 
+  # Copies directories in pathfile to a destination, such that the destination has no references to
+  # directories outside of the destination in the load path.
+  #
+  # Hierarchy of destination directory:
+  #   destination/
+  #      Pathfile     # new paths
+  #      dependency_directory/
+  #         dependency1         # Copied from original location
+  #
+  # This is very useful for deployment, for example.
+  #
+  # @param [String] copy_outside_paths the directory to stage dependencies in
+  # @param [String] dependency_directory the subdir within destination to put dependencies in
+  #
+  # TODO(ev): Break this function up into a set of more functional primitives
+  def self.copy_outside_paths!(destination, dependency_directory = "pathological_dependencies")
+    saved_exclude_root = @@exclude_root
+    begin
+      self.excluderoot_mode
+      pathfile = self.find_pathfile
+      # Nothing to do if there's no Pathfile
+      return unless pathfile && File.file?(pathfile)
+
+      foreign_paths = self.find_load_paths(pathfile).uniq
+      return if foreign_paths.empty?
+
+      path_root = File.join(destination, dependency_directory)
+      FileUtils.mkdir_p path_root
+
+      # Copy in each path and save the relative paths to write to the rewritten Pathfile. We copy each unique
+      # path into the folder not as the basename, but as the longest suffix of the path necessary to make it
+      # unique. (Otherwise this won't work if you have two entries with the same basename in the Pathfile,
+      # such as "foo/lib" and "bar/lib".)
+      common_prefix = find_longest_common_prefix(foreign_paths)
+      new_pathfile_paths = foreign_paths.map do |foreign_path|
+        path_short_name = foreign_path.gsub(/^#{common_prefix}/, "")
+        symlinked_name = File.join(path_root, path_short_name)
+        FileUtils.mkdir_p File.split(symlinked_name)[0]
+        debug "About to move #{foreign_path} to #{symlinked_name}..."
+        copy_directory(foreign_path, symlinked_name)
+        File.join(dependency_directory, path_short_name)
+      end
+      # Overwrite the Pathfile with the new relative paths.
+      File.open(File.join(destination, "Pathfile"), "w") do |file|
+        new_pathfile_paths.each { |path| file.puts path }
+      end
+    ensure
+      @@exclude_root = saved_exclude_root
+    end
+  end
+
   # Convenience functions for the various modes in which Pathological may run.
 
   def self.debug_mode; @@debug = true; end
@@ -155,9 +206,35 @@ module Pathological
     @@exclude_root ? paths.reject { |path| File.expand_path(path) == File.expand_path(root) } : paths
   end
 
-  # 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.)
+  # Find the longest common path prefix amongst a list of paths
+  #
+  # @private
+  # @param [List<String>] a list of paths
+  # @return [String] the longest common prefix, or "/"
+  def self.find_longest_common_prefix(paths)
+    if paths.size == 1
+      common_prefix = File.split(paths[0])[0]
+    else
+      common_prefix = "/"
+      paths[0].split("/").reject(&:empty?).each do |part|
+        new_prefix = "#{common_prefix}#{part}/"
+        break unless paths.all? { |path| path.start_with? new_prefix }
+        common_prefix = new_prefix
+      end
+    end
+    common_prefix
+  end
+
+  # Copies a directory and all its symlinks to a destination.
+  # @private
+  def self.copy_directory(source, dest)
+    rsync_command = "rsync -r --archive --links --copy-unsafe-links --delete #{source}/ '#{dest}'"
+    debug `#{rsync_command}`
+  end
+
+  # 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.)
   #
   # @return [String] name of file requiring pathological, or the currently executing file.
   def self.requiring_filename
@@ -173,7 +250,7 @@ module Pathological
     requiring_file ? requiring_file.match(/(.+):\d+/)[1] : $0 rescue $0
   end
 
-  private_class_method :debug, :real_path, :parse_pathfile
+  private_class_method :debug, :real_path, :parse_pathfile, :find_longest_common_prefix, :copy_directory
 
   # Reset options
   Pathological.reset!

data/lib/pathological/version.rb

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

data/pathological.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">=0") if s.respond_to? :required_rubygems_version=
   s.specification_version = 2 if s.respond_to? :specification_version=
 
-  s.authors = "Daniel MacDougall", "Caleb Spare"
-  s.email = "dmac@ooyala.com", "caleb@ooyala.com"
+  s.authors = "Daniel MacDougall", "Caleb Spare", "Evan Chan"
+  s.email = "dmac@ooyala.com", "caleb@ooyala.com", "ev@ooyala.com"
   s.homepage = "http://www.ooyala.com"
   s.rubyforge_project = "pathological"
 
@@ -28,4 +28,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rr", ">= 1.0.3"
   s.add_development_dependency "scope", ">= 0.2.3"
   s.add_development_dependency "fakefs"
+  s.add_development_dependency "rake"
 end

data/test/{pathological → unit/pathological}/base_test.rb

@@ -210,6 +210,45 @@ module Pathological
           assert_load_path ["/foo/bar"]
         end
       end
+
+      context "#copy_outside_paths!" do
+        setup do
+          @destination = "/tmp/staging"
+          @pathfile = "/Pathfile"
+          FileUtils.cd "/"
+          FileUtils.mkdir_p @destination
+          @source_paths = ["/src/github1", "/src/moofoo"]
+          @source_paths.each { |src_dir| FileUtils.mkdir_p src_dir }
+        end
+
+        should "return immediately if there is no Pathfile" do
+          mock(Pathological).find_pathfile { nil }
+          Pathological.copy_outside_paths! @destination
+          refute File.directory?(File.join(@destination, "pathological_dependencies"))
+        end
+
+        should "return immediately if Pathfile is empty" do
+          File.open(@pathfile, "w") { |f| f.puts "\n# What the heck is this file?\n\n" }
+          Pathological.copy_outside_paths! @destination
+          refute File.directory?(File.join(@destination, "pathological_dependencies"))
+        end
+
+        should "copy source dirs as links and rewrite Pathfile" do
+          File.open(@pathfile, "w") { |f| f.puts @source_paths.join("\n") }
+
+          final_path = File.join(@destination, "pathological_dependencies")
+          @source_paths.each do |source_path|
+            mock(Pathological).copy_directory(source_path, final_path + source_path.gsub("/src", "")).once
+          end
+          Pathological.copy_outside_paths! @destination
+
+          assert File.directory?(final_path)
+          destination_paths = @source_paths.map do |source_path|
+            "pathological_dependencies#{source_path.gsub("/src", "")}"
+          end
+          assert_equal destination_paths, File.read(File.join(@destination, "Pathfile")).split("\n")
+        end
+      end
     end
   end
 end

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: pathological
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
 - Daniel MacDougall
 - Caleb Spare
+- Evan Chan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-29 00:00:00.000000000Z
+date: 2012-09-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &2153778480 !ruby/object:Gem::Requirement
+  requirement: &27117160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +23,10 @@ dependencies:
         version: 1.0.3
   type: :development
   prerelease: false
-  version_requirements: *2153778480
+  version_requirements: *27117160
 - !ruby/object:Gem::Dependency
   name: scope
-  requirement: &2153778020 !ruby/object:Gem::Requirement
+  requirement: &27091120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +34,10 @@ dependencies:
         version: 0.2.3
   type: :development
   prerelease: false
-  version_requirements: *2153778020
+  version_requirements: *27091120
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &2153777640 !ruby/object:Gem::Requirement
+  requirement: &27090740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,13 +45,25 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153777640
+  version_requirements: *27090740
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &27090280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *27090280
 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"
 email:
 - dmac@ooyala.com
 - caleb@ooyala.com
+- ev@ooyala.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -71,8 +84,7 @@ files:
 - lib/pathological/parentdir.rb
 - lib/pathological/version.rb
 - pathological.gemspec
-- test/pathological/base_test.rb
-- test/unit.watchr.rb
+- test/unit/pathological/base_test.rb
 homepage: http://www.ooyala.com
 licenses: []
 post_install_message: 
@@ -93,8 +105,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: pathological
-rubygems_version: 1.8.7
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: A nice way to manage your project's require paths.
 test_files: []
+has_rdoc: 

data/test/unit.watchr.rb

@@ -1,10 +0,0 @@
-# Watchr script for unit tests
-
-def run_test(test)
-  system("bundle exec ruby #{test}")
-end
-
-watch(/^test\/.*_test\.rb/) { |md| run_test(md[0]) }
-watch(/^lib\/(.*)\.rb/) { |md| run_test("test/#{md[1]}_test.rb") }
-
-Signal.trap("INT") { abort("\n") }