project_scout 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rick Lee-Morlang
+
+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.rdoc

@@ -0,0 +1,33 @@
+= ProjectScout
+
+This is a simple library extracted from a few other projects. 
+
+It can scan a directory and all of its parents for various
+signs that the directory is the root of a Ruby project.
+The exact methods used to detect a Ruby project can be
+somewhat customized.
+
+Recently refactored for future extensibility, documented,
+and added test cases.
+
+Bonus shell command included: ruby-project-root
+
+== Usage
+
+See ProjectScout and ProjectScout::Dir for more info.
+
+  ProjectScout::Dir("/home/user/bubbles").ruby_project?
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Rick Lee-Morlang. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "project_scout"
+    gem.summary = %Q{scan directories to find the root directory of a project}
+    gem.description = %Q{scan directories to find the root directory of a project}
+    gem.email = "rick@lee-morlang.com"
+    gem.homepage = "http://github.com/rleemorlang/project_scout"
+    gem.authors = ["Rick Lee-Morlang"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "project_scout #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/ruby-project-root

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+project_scout = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(project_scout) unless $LOAD_PATH.include?(project_scout)
+
+require 'project_scout'
+
+project_root = ProjectScout.scan Dir.pwd
+
+if project_root.nil?
+  exit 1
+else
+  puts project_root
+end
+

data/lib/project_scout/dir.rb

@@ -0,0 +1,70 @@
+module ProjectScout
+
+  # This is a helper class with a bit of syntactical magic. Want to know if 
+  # /home/user/bubbles is a Rails project?
+  #
+  #   ProjectScout::Dir("/home/user/bubbles").ruby_rails_project?
+  #
+  # Want to know if it's any sort of Ruby project?
+  #
+  #   ProjectScout::Dir("/home/user/bubbles").ruby_project?
+  #
+  class Dir
+    attr_accessor :path
+
+    def initialize(path)
+      self.path = path
+    end
+
+    def ruby_cucumber?
+      contains? "features/env.rb"
+    end
+
+    def ruby_rails?
+      contains? "config/environment.rb"
+    end
+
+    def ruby_rspec?
+      contains? "spec/spec_helper.rb"
+    end
+
+    def local_methods
+      self.methods - self.class.methods
+    end
+
+    # Explanation of magic:
+    # 
+    # 1) if a method is invoked with a "_project?" suffix, strip "_project"
+    #    and call with the same arguments. Thus calling foo_bar_project? 
+    #    invokes foo_bar?
+    #
+    # 2) if a method invoked has no underscores in it, and local methods
+    #    exist that start with the same string, invoke all of them and 
+    #    return true if and return true. Thus calling foo_project? when 
+    #    foo_bar_project? and foo_baz_project? exist will return true 
+    #    only if any of foo_bar_project? and foo_baz_project? return true.
+    #
+    def method_missing(method, *args)
+      method = method.to_s
+      if method.end_with? "_project?"
+        method.sub! "_project", ""
+        self.send method.to_sym, *args
+      elsif !method.include?("_") && local_methods.find { |m| m.to_s.start_with? "#{method.chop}_" }
+        project_methods = local_methods.find_all { |m| m.to_s.start_with? "#{method.chop}_" }
+        project_methods.collect { |m| self.send m.to_s }.any?
+      else
+        raise NameError.new("undefined local variable or method '#{method}' for ProjectScout::Dir")
+      end
+    end
+
+    def contains?(path_suffix)
+      File.exists?(File.join(path, path_suffix))
+    end
+  end
+
+  class << self
+    def Dir(path)
+      ProjectScout::Dir.new path
+    end
+  end
+end

data/lib/project_scout.rb

@@ -0,0 +1,46 @@
+require 'project_scout/dir'
+
+module ProjectScout
+  class << self
+    # Search recursively from the current working directory up for something
+    # that looks like the root directory of a Ruby project.
+    #
+    # Returns the path to the first found project dir, if any. Nil otherwise.
+    #
+    # Stops looking when it reaches the top of the tree.
+    #
+    # By default, it will search for any kind of ruby project, but you can
+    # specify exactly how to scan using the optional :for parameter. See
+    # ProjectScout::Dir for the kinds of projects you can scan for.
+    # 
+    # Example Usage:
+    # ProjectScout.scan "/some/path"
+    # ProjectScout.scan "/some/path", :for => [ :ruby_rails, :ruby_cucumber ]
+    #
+    def scan(path, options = {})
+      unless File.directory? path
+        raise RuntimeError.new("#{path} does not exist")
+      end
+
+      path = File.expand_path(path)
+      while path != '/'
+        result = check_path path, options[:for]
+        return result unless result.nil?
+        path = File.expand_path(path + '/..')
+      end
+      nil
+    end
+
+    protected
+
+    def check_path(path, check_for)
+      check_for ||= [:ruby]
+      check_for.to_a.each do |project_kind|
+        result = Dir(path).send "#{project_kind}_project?".to_sym 
+        return path if result == true
+      end
+      return nil
+    end
+  end
+end
+

data/spec/project_scout/dir_spec.rb

@@ -0,0 +1,51 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+module ProjectScout
+  describe Dir do
+    it "should define a shortcut initializer" do
+      ProjectScout::Dir("/").should be_a_kind_of(ProjectScout::Dir)
+    end
+
+    describe "an instance" do
+      before do
+        File.stub! :directory? => true
+      end
+      subject { Dir.new "/parent" }
+
+      describe "#ruby_rails?" do
+        it "should be true if the directory is the root of a rails project" do
+          File.should_receive(:exists?).with("/parent/config/environment.rb").and_return true
+          subject.should be_a_ruby_rails_project
+        end
+          
+        it "should be false if the directory is not the root of a rails project" do
+          File.should_receive(:exists?).with("/parent/config/environment.rb").and_return false
+          subject.should_not be_a_ruby_rails_project
+        end
+
+        it "should check if the path contains config/environment.rb" do
+          subject.should_receive(:contains?).with("config/environment.rb")
+          subject.ruby_rails_project?
+        end
+      end
+
+      specify "#ruby_cucumber? should check if the path contains features/env.rb" do
+        subject.should_receive(:contains?).with("features/env.rb")
+        subject.ruby_cucumber_project?
+      end
+      
+      specify "#ruby_spec? should check if the path contains spec/spec_helper.rb" do
+        subject.should_receive(:contains?).with("spec/spec_helper.rb")
+        subject.ruby_rspec_project?
+      end
+
+      specify "#ruby? should check if the path is any sort of ruby project?" do
+        subject.should_receive :ruby_rspec?
+        subject.should_receive :ruby_cucumber?
+        subject.should_receive :ruby_rails?
+        subject.ruby_project?
+      end
+
+    end
+  end
+end

data/spec/project_scout_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "ProjectScout" do
+  describe "scan" do
+    before do
+      @ps_dir = mock("ProjectScout::Dir").as_null_object
+      ProjectScout.stub!(:Dir).and_return(@ps_dir)
+
+      File.stub! :directory? => true
+      File.stub! :expand_path do |param|
+        case param 
+        when "/some/dir"
+          "/some/dir"
+        when "/some/dir/.."
+          "/"
+        end
+      end
+    end
+      
+    it "should check to make sure the specified path exists" do
+      dir = "/non/existent/directory"
+      File.should_receive(:directory?).with(dir).and_return false
+      lambda {
+        ProjectScout.scan dir
+      }.should raise_error(/does not exist/)
+    end
+
+    describe "default behaviour" do
+      it "should recurse upward" do
+        File.should_receive(:expand_path).with("/a/b/c").ordered.and_return("/a/b/c")
+
+        File.should_receive(:expand_path).with("/a/b/c/..").ordered.and_return("/a/b")
+        File.should_receive(:expand_path).with("/a/b/..").ordered.and_return("/a")
+        File.should_receive(:expand_path).with("/a/..").ordered.and_return("/")
+        File.should_not_receive(:expand_path).with("/..")
+
+        ProjectScout.scan "/a/b/c"
+      end
+
+      it "should scan for any kind of Ruby project" do
+        ProjectScout.should_receive(:Dir).with("/some/dir").and_return(@ps_dir)
+        @ps_dir.should_receive(:ruby_project?)
+        ProjectScout.scan "/some/dir"        
+      end
+    end
+
+    it "should allow the kinds of projects scanned for to be specified" do
+      @ps_dir.should_not_receive :ruby_project?
+      @ps_dir.should_receive :smurf_project?
+      @ps_dir.should_receive :fraggle_project?
+      ProjectScout.scan "/some/dir", :for => [ :smurf, :fraggle ]
+    end
+
+    it "should return the matching directory if a project directory is found" do
+      @ps_dir.stub!(:ruby_project?).and_return(true)
+      ProjectScout.scan("/some/dir").should == "/some/dir"
+    end
+
+    it "should return nil if no matching directory is found" do
+      @ps_dir.stub!(:ruby_project?).and_return(false)
+      ProjectScout.scan("/some/dir").should be_nil
+    end
+  end
+end
+
+#ProjectScout.scan "/a/directory", :without_recursion, :for => :ruby_rails

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--backtrace
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'project_scout'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: project_scout
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rick Lee-Morlang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 -08:00
+default_executable: ruby-project-root
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: scan directories to find the root directory of a project
+email: rick@lee-morlang.com
+executables: 
+- ruby-project-root
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/ruby-project-root
+- lib/project_scout.rb
+- lib/project_scout/dir.rb
+- spec/project_scout/dir_spec.rb
+- spec/project_scout_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rleemorlang/project_scout
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: scan directories to find the root directory of a project
+test_files: 
+- spec/project_scout/dir_spec.rb
+- spec/project_scout_spec.rb
+- spec/spec_helper.rb