prj 0.1.0 → 1.0.0

data/Gemfile

@@ -1,11 +1,10 @@
-source :rubygems
+source 'https://rubygems.org'
 
 group :development do
   gem "rspec", "~> 2.11"
   gem "rake",  "~> 0.9"
   gem 'simplecov', "~> 0.6", :require => false
-  gem "fakefs", "~> 0.4", :require => "fakefs/safe"
-  gem 'pry'
+  gem "rake-compiler"
 end
 
 

data/Gemfile.lock

@@ -1,16 +1,11 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    coderay (1.0.7)
     diff-lcs (1.1.3)
-    fakefs (0.4.2)
-    method_source (0.8)
     multi_json (1.3.7)
-    pry (0.9.10)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.3.1)
     rake (0.9.5)
+    rake-compiler (0.8.3)
+      rake
     rspec (2.12.0)
       rspec-core (~> 2.12.0)
       rspec-expectations (~> 2.12.0)
@@ -23,14 +18,12 @@ GEM
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.3.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakefs (~> 0.4)
-  pry
   rake (~> 0.9)
+  rake-compiler
   rspec (~> 2.11)
   simplecov (~> 0.6)

data/README.md

@@ -14,6 +14,8 @@ contains supplied letters in given order. The search is scoped by projects root
 directory, which is specified in ~/.prj.yml config file (Default: ~/Projects).
 See Installation & Configuration section.
 
+*now even faster with C extension*
+
 Installation & Configuration:
 -----------------------------
 1. Install the gem:
@@ -27,8 +29,9 @@ Installation & Configuration:
 3. Put a project root directory name into ~/.prj.yml, i.e:
    ```
    projects_root: ~/Projects
-   case_sensitive: false
-   vcs_directories:
+   case_sensitive: false                 # default: true
+   search_nested_repositories: false     # default: false (slower if true)
+   vcs_directories:                      # default: [.git]
      - .git
      - .svn
      - .hg

data/Rakefile

@@ -24,3 +24,9 @@ end
 task :all_specs => [:spec, :acceptance_spec]
 task :default => [:all_specs]
 
+require 'rake/extensiontask'
+Rake::ExtensionTask.new do |t|
+  t.name    = 'finder'
+  t.ext_dir = 'ext/prj'
+  t.lib_dir = 'lib/prj'
+end

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.0

data/bin/prj

@@ -2,7 +2,7 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
 
-require 'rubygems'
+$:.unshift File.expand_path("../../lib", __FILE__)
 require 'prj'
 
 include Prj

data/ext/prj/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+
+dir_config('finder')
+create_makefile('finder')

data/ext/prj/finder.c

@@ -0,0 +1,127 @@
+#include <ruby.h>
+
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fts.h>
+
+void Init_finder();
+
+VALUE prj_finder_initialize_m(VALUE self, VALUE projectsRoot, VALUE options);
+VALUE expand_path(VALUE path);
+
+VALUE prj_finder_find_project_directories_m(VALUE self);
+VALUE prj_finder_traverse_projects_root(VALUE self, char *projectsRoot, int searchNestedRepositories, VALUE (*callback)(VALUE self, const FTS *fs, const FTSENT *parent, const FTSENT *child));
+VALUE prj_finder_collect_project(VALUE self, const FTS *fs, const FTSENT *parent, const FTSENT *child);
+char * prj_finder_normalize_path(char *path);
+VALUE prj_finder_is_vcs_dir(VALUE self, const char *dir);
+
+VALUE Prj, PrjFinder;
+
+void Init_finder() {
+  Prj = rb_define_module("Prj");
+  PrjFinder = rb_define_class_under(Prj, "Finder", rb_cObject);
+  rb_define_method(PrjFinder, "initialize", prj_finder_initialize_m, 2);
+  rb_define_method(PrjFinder, "find_project_directories", prj_finder_find_project_directories_m, 0);
+}
+
+VALUE prj_finder_initialize_m(VALUE self, VALUE projectsRoot, VALUE options) {
+  VALUE expandedProjectsRoot, vcsDirectories, searchNestedRepositories;
+  expandedProjectsRoot = expand_path(projectsRoot);
+
+  vcsDirectories = rb_hash_aref(options, ID2SYM(rb_intern("vcs_directories")));
+
+  if (!RTEST(vcsDirectories)) {
+    vcsDirectories = rb_ary_new();
+  }
+
+  searchNestedRepositories = rb_hash_aref(options, ID2SYM(rb_intern("search_nested_repositories")));
+
+  rb_iv_set(self, "@root", expandedProjectsRoot);
+  rb_iv_set(self, "@vcs_directories", rb_check_array_type(vcsDirectories));
+  rb_iv_set(self, "@search_nested_repositories", searchNestedRepositories);
+  rb_iv_set(self, "@project_directories", rb_ary_new());
+  return self;
+}
+
+VALUE expand_path(VALUE path) {
+  VALUE file;
+  file = rb_const_get(rb_cObject, rb_intern("File"));
+  return rb_funcall(file, rb_intern("expand_path"), 1, rb_check_string_type(path));
+}
+
+VALUE prj_finder_find_project_directories_m(VALUE self) {
+  VALUE result, root, searchNestedRepositories;
+
+  result       = rb_iv_get(self, "@project_directories");
+  root         = rb_iv_get(self, "@root");
+  searchNestedRepositories = rb_iv_get(self, "@search_nested_repositories");
+
+  if (RARRAY_LEN(result) == 0) {
+    prj_finder_traverse_projects_root(self, StringValueCStr(root), RTEST(searchNestedRepositories), &prj_finder_collect_project);
+  }
+
+  return result;
+}
+
+VALUE prj_finder_traverse_projects_root(VALUE self, char *projectsRoot, int searchNestedRepositories, VALUE (*callback)(VALUE self, const FTS *fs, const FTSENT *parent, const FTSENT *child)) {
+  FTS *fs        = NULL;
+  FTSENT *child  = NULL;
+  FTSENT *parent = NULL;
+
+  char *paths[] = { projectsRoot, NULL };
+  fs = fts_open(paths, FTS_COMFOLLOW | FTS_LOGICAL | FTS_NOSTAT, NULL);
+
+  if (fs == NULL) {
+    return Qnil;
+  }
+
+  while ((parent = fts_read(fs)) != NULL) {
+    child = fts_children(fs, 0);
+    while (child != NULL) {
+      if (child->fts_info == FTS_D && RTEST(callback(self, fs, parent, child))) {
+        fts_set(fs, (searchNestedRepositories ? child : parent), FTS_SKIP);
+      }
+      child = child->fts_link;
+    }
+  }
+  fts_close(fs);
+
+  return Qnil;
+}
+
+VALUE prj_finder_collect_project(VALUE self, const FTS *fs, const FTSENT *parent, const FTSENT *child) {
+  VALUE root, result;
+  char *prefixed, *unprefixed;
+
+  if (!prj_finder_is_vcs_dir(self, child->fts_name)) {
+    return Qfalse;
+  }
+
+  root   = rb_iv_get(self, "@root");
+  result = rb_iv_get(self, "@project_directories");
+
+  prefixed   = parent->fts_path;
+  unprefixed = prefixed + RSTRING_LEN(root);
+
+  rb_ary_push(result, rb_str_new2(prj_finder_normalize_path(unprefixed)));
+  return Qtrue;
+}
+
+// strips unnecessary trailing / on linux
+char * prj_finder_normalize_path(char *path) {
+  size_t path_length;
+  path_length = strlen(path);
+
+  if (path[path_length - 1] == '/') {
+    path[path_length - 1] = '\0';
+  }
+
+  return path;
+}
+
+VALUE prj_finder_is_vcs_dir(VALUE self, const char *dir) {
+  VALUE vcsDirectories;
+  vcsDirectories = rb_iv_get(self, "@vcs_directories");
+  return rb_funcall(vcsDirectories, rb_intern("include?"), 1, rb_str_new2(dir));
+}
+

data/lib/prj/app.rb

@@ -18,11 +18,11 @@ module Prj
         @output.puts config.fetch("projects_root")
         return 0
       end
-      finder = Finder.new(config.fetch("projects_root"), config.fetch("vcs_directories"))
-      filter = Filter.new(@letters, config.fetch("case_sensitive") { true })
+      finder = Finder.new(config.fetch("projects_root"), symbolize_keys(config))
+      filter = Filter.new(@letters, config.fetch("case_sensitive"))
       directories = finder.find_project_directories
       filtered_directories = filter.filter(directories)
-      target_directory = File.join(config.fetch("projects_root"), filtered_directories.first.to_s)
+      target_directory = File.expand_path(File.join(config.fetch("projects_root"), filtered_directories.first.to_s))
       @output.puts target_directory
       0
     end
@@ -38,10 +38,15 @@ module Prj
 
     def default_config
       default_config = {
-        "projects_root" => File.expand_path("~/Projects"),
-        "vcs_directories" => [".git"]
+        "projects_root"   => File.expand_path("~/Projects"),
+        "vcs_directories" => [".git"],
+        "case_sensitive"  => true
       }
     end
+
+    def symbolize_keys(hash)
+      Hash[hash.map { |k, v| [k.to_sym, v] }]
+    end
   end
 
 end

data/spec/acceptance/app_spec.rb

@@ -1,18 +1,16 @@
 require 'spec_helper'
-require 'fakefs/spec_helpers'
+require 'tmpdir'
 require 'fileutils'
 require 'prj'
 require 'stringio'
 require 'yaml'
 
 describe "Prj::App" do
-  include FakeFS::SpecHelpers
-
   let(:output) { StringIO.new }
-  let(:root) { "/Projects" }
   let(:subdirectories) do
     [
       "foo/.git/",
+      "foo/baz/.git/",
       "bar/",
       "baz/qux/crisp/.git/",
       "baz/craps/poops/.git/",
@@ -20,9 +18,12 @@ describe "Prj::App" do
     ].map { |d| File.join(root, d) }
   end
 
-  before(:each) do
-    FileUtils.mkdir_p(root)
-    subdirectories.each { |d| FileUtils.mkdir_p(d) }
+  around(:each) do |example|
+    Dir.mktmpdir("Projects") do |root|
+      @root = root
+      subdirectories.each { |d| FileUtils.mkdir_p(d) }
+      example.run
+    end
   end
 
   context "within projcts root" do
@@ -36,7 +37,7 @@ describe "Prj::App" do
     it "prints projects root and returns 0 if directory not found" do
       with_config("projects_root" => root) do
         Prj::App.new(output, ["nothingtofind"]).run.should == 0
-        output.string.chomp.should == root + "/"
+        output.string.chomp.should == root
       end
     end
 
@@ -46,6 +47,20 @@ describe "Prj::App" do
         output.string.chomp.should == File.join(root, "foo")
       end
     end
+
+    it "does not search nested repos by default" do
+      with_config("projects_root" => root) do
+        Prj::App.new(output, ["fob"]).run.should == 0
+        output.string.chomp.should_not == File.join(root, "foo/baz")
+      end
+    end
+
+    it "can search nested repos if 'search_nested_repositories' option is true" do
+      with_config("projects_root" => root, "search_nested_repositories" => true) do
+        Prj::App.new(output, ["fob"]).run.should == 0
+        output.string.chomp.should == File.join(root, "foo/baz")
+      end
+    end
   end
 
   it "uses ~/.prj.yml as config file" do
@@ -53,17 +68,23 @@ describe "Prj::App" do
   end
 
   it "defaults to ~/Projects as default projects root" do
-    Prj::App.new(output, ["asdf"]).config.fetch("projects_root").should == File.expand_path("~/Projects")
+    with_config do
+      Prj::App.new(output, ["asdf"]).config.fetch("projects_root").should == File.expand_path("~/Projects")
+    end
   end
 
   def with_config(config = {})
     tmp = Prj::App.config_path
-    config_path = ".prj.yml"
+    config_path = File.join(Dir.tmpdir, ".prj.yml")
     File.open(config_path, "w") { |f| f.write YAML.dump(config) }
     Prj::App.config_path = config_path
     yield
   ensure
     Prj::App.config_path = tmp
   end
+
+  def root
+    @root
+  end
 end
 

data/spec/lib/prj/finder_spec.rb

@@ -1,34 +1,46 @@
 require 'spec_helper'
-require 'fakefs/spec_helpers'
+require 'tmpdir'
 require 'fileutils'
 require 'prj/finder'
 
 describe "Prj::Finder" do
-  include FakeFS::SpecHelpers
-
-  let(:root) { "~/projects" }
+  around(:each) do |example|
+    Dir.mktmpdir("projects") do |root|
+      @root = root
+      example.run
+    end
+  end
 
   it "finds directories containing .git/ scoped to given root and returns their relative paths" do
     make_directories(root, "/foo/.git", "/bar/qux", "/baz/.git")
-    finder(".git").find_project_directories.should =~ ["/foo", "/baz"]
+    finder(:vcs_directories => [".git"]).find_project_directories.should =~ ["/foo", "/baz"]
   end
 
-  it "does not find directories nested under directory containing .git/" do
+  it "does not find nested repos unless :search_nested_repositories" do
     make_directories(root, "/foo/.git", "/foo/bar", "/foo/baz/.git")
-    finder(".git").find_project_directories.should =~ ["/foo"]
+    finder(:vcs_directories => [".git"]).find_project_directories.should =~ ["/foo"]
+  end
+
+  it "finds nested repos if :search_nested_repositories option is true" do
+    make_directories(root, "/foo/.git", "/foo/bar", "/foo/baz/.git")
+    finder(:vcs_directories => [".git"], :search_nested_repositories => true).find_project_directories.should =~ ["/foo", "/foo/baz"]
   end
 
   it "does support other vcs repos" do
     make_directories(root, "/foo/.git", "/bar/.svn", "/foo/baz/.unknown")
-    finder(".git", ".svn").find_project_directories.should =~ ["/foo", "/bar"]
+    finder(:vcs_directories => [".git", ".svn"]).find_project_directories.should =~ ["/foo", "/bar"]
   end
 
   def make_directories(root, *directories)
     directories.each { |d| FileUtils.mkdir_p(File.join(root, d)) }
   end
 
-  def finder(*vcs_directories)
-    Prj::Finder.new(root, vcs_directories)
+  def finder(options = {})
+    Prj::Finder.new(root, options)
+  end
+
+  def root
+    @root
   end
 end
 

metadata

@@ -2,14 +2,14 @@
 name: prj
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Vladimir Yarotsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-09 00:00:00.000000000 Z
+date: 2013-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,22 +59,6 @@ dependencies:
         version: '0.6'
   type: :development
   prerelease: false
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
 description: ! '    Prj is an utility to quickly go to project directory using fuzzy
   matching
 
@@ -82,15 +66,18 @@ description: ! '    Prj is an utility to quickly go to project directory using f
 email: vladimir.yarotksy@gmail.com
 executables:
 - prj
-extensions: []
+extensions:
+- ext/prj/extconf.rb
 extra_rdoc_files: []
 files:
 - bin/prj
 - lib/prj/app.rb
 - lib/prj/dir_with_score.rb
 - lib/prj/filter.rb
-- lib/prj/finder.rb
+- lib/prj/finder.bundle
 - lib/prj.rb
+- ext/prj/extconf.rb
+- ext/prj/finder.c
 - spec/acceptance/app_spec.rb
 - spec/lib/prj/filter_spec.rb
 - spec/lib/prj/finder_spec.rb

data/lib/prj/finder.rb

@@ -1,25 +0,0 @@
-require 'find'
-
-module Prj
-
-  class Finder
-    def initialize(root, vcs_directories)
-      @root = File.expand_path(root)
-      @vcs_directories = Array(vcs_directories)
-    end
-
-    ##
-    # Returns directories containing .git/ directory, relative to @root
-    #
-    def find_project_directories
-      subdirectories = []
-      Find.find(@root) do |d|
-        if @vcs_directories.any? { |vcs_dir| Dir.exists?(File.join(d, vcs_dir)) }
-          subdirectories << d && Find.prune
-        end
-      end
-      subdirectories.map { |r| r.gsub(@root, "") }
-    end
-  end
-
-end