prj 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -3,7 +3,7 @@ GEM
   specs:
     coderay (1.0.7)
     diff-lcs (1.1.3)
-    fakefs (0.4.1)
+    fakefs (0.4.2)
     method_source (0.8)
     multi_json (1.3.7)
     pry (0.9.10)

data/README.md

@@ -1,26 +1,48 @@
 Prj
 ==========
 
+[![Build Status](https://secure.travis-ci.org/v-yarotsky/prj.png)](http://travis-ci.org/v-yarotsky/prj)
+[![Code Climate](https://codeclimate.com/github/v-yarotsky/prj.png)](https://codeclimate.com/github/v-yarotsky/prj)
+[![Gem Version](https://badge.fury.io/rb/prj.png)](http://badge.fury.io/rb/prj)
+
 Cd to your project the right way!
 
-Prj chooses a project directory based on fuzzy matching
+Prj chooses a project directory based on fuzzy matching.
 
-Usage:
-------
+It finds a project directory (a directory with .git/ or other vcs directory inside) such that it's name
+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.
 
-Put this into your .zshrc (.bashrc)
+Installation & Configuration:
+-----------------------------
+1. Install the gem:
 
-```
-function p() {
-  builtin cd "$(prj $1)"
-}
-```
+   ```gem install prj```
 
-Put a project root directory into ~/.prj, i.e:
+   ([RVM](http://rvm.io) users) check out [this blog post](http://blog.yarotsky.me/2012-12-15-faster-ruby-scripts-startup)
+2. ([oh-my-zsh](https://github.com/robbyrussell/oh-my-zsh) users) Put [scripts/zsh/prj.plugin.zsh](https://raw.github.com/v-yarotsky/prj/master/scripts/zsh/prj.plugin.zsh) into ``~/.oh-my-zsh/custom/plugins/prj/prj.plugin.zsh``.
+   Don't forget to enable the plugin in ~/.zshrc
 
+3. Put a project root directory name into ~/.prj.yml, i.e:
+   ```
+   projects_root: ~/Projects
+   vcs_directories:
+     - .git
+     - .svn
+     - .hg
+   ```
+
+Usage:
+------
+
+With the following directory structure
 ```
-~/Projects
+~/
+  Projects/
+    my_super_project/
+    rails/
+    love_hate_unicorns/
 ```
-
-and run ```p letters_from_your_project_folder_name```
+You can reach ``~/Projects/my_super_project`` with ```p msp```
 

data/Rakefile

@@ -17,10 +17,10 @@ RSpec::Core::RakeTask.new do |t|
   t.pattern = 'spec/lib/**/*_spec.rb'
 end
 
-RSpec::Core::RakeTask.new do |t|
+RSpec::Core::RakeTask.new(:acceptance_spec) do |t|
   t.pattern = 'spec/acceptance/**/*_spec.rb'
-  t.name = :acceptance_spec
 end
 
-task :default => [:spec]
+task :all_specs => [:spec, :acceptance_spec]
+task :default => [:all_specs]
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/bin/prj

@@ -4,7 +4,6 @@
 
 require 'rubygems'
 require 'prj'
-require 'prj/app'
 
 include Prj
 

data/lib/prj/app.rb

@@ -1,48 +1,48 @@
-require 'prj/finder'
-require 'prj/filter'
+require 'yaml'
 
 module Prj
+
   class App
     class << self
-      attr_accessor :default_projects_root, :ignore_config
+      attr_accessor :config_path
     end
-    @default_projects_root = "~/Projects".freeze
-    @ignore_config = false
+    @config_path = File.expand_path("~/.prj.yml").freeze
 
-    def initialize(sink, args = [])
+    def initialize(output, args = [])
       @letters = String(args.first).each_char.to_a
-      @sink = sink
+      @output = output
     end
 
     def run
       if @letters.empty?
-        @sink.puts projects_root
-      else
-        finder = Finder.new(projects_root)
-        filter = Filter.new(@letters)
-
-        directories = finder.find_project_directories
-        filtered_directories = filter.filter(directories)
-
-        target_directory = File.join(projects_root, filtered_directories.first.to_s)
-
-        @sink.puts target_directory
+        @output.puts config.fetch("projects_root")
+        return 0
       end
-
-      return 0
+      finder = Finder.new(config.fetch("projects_root"), config.fetch("vcs_directories"))
+      filter = Filter.new(@letters)
+      directories = finder.find_project_directories
+      filtered_directories = filter.filter(directories)
+      target_directory = File.join(config.fetch("projects_root"), filtered_directories.first.to_s)
+      @output.puts target_directory
+      0
     end
 
-    def projects_root
-      @projects_root ||= begin
-        path = begin
-          raise "default config" if self.class.ignore_config
-          File.read(File.expand_path("~/.prj")).chomp
-        rescue
-          self.class.default_projects_root
-        end
-        File.expand_path(path).freeze
+    def config
+      @config ||= begin
+        config = File.exists?(self.class.config_path) ? YAML.load(File.read(self.class.config_path)) : {}
+        default_config.merge(config)
       end
     end
+
+    private
+
+    def default_config
+      default_config = {
+        "projects_root" => File.expand_path("~/Projects"),
+        "vcs_directories" => [".git"]
+      }
+    end
   end
+
 end
 

data/lib/prj/dir_with_score.rb

@@ -0,0 +1,34 @@
+require 'forwardable'
+
+module Prj
+
+  class DirWithScore
+    include Comparable
+    extend Forwardable
+
+    attr_accessor :dir, :score
+
+    def_delegators :dir, :length, :to_s
+
+    def initialize(dir, score)
+      @dir, @score = dir, score
+    end
+
+    def <=>(other)
+      if score < other.score
+        -1
+      elsif score > other.score
+        1
+      else
+        if length < other.length
+          -1
+        elsif  length > other.length
+          1
+        else
+          0
+        end
+      end
+    end
+  end
+
+end

data/lib/prj/filter.rb

@@ -1,56 +1,30 @@
+require 'prj/dir_with_score'
+require 'strscan'
+
 module Prj
+
   class Filter
     def initialize(letters)
       @letters = letters.to_a
     end
 
     def filter(directories)
-      sort(directories.select { |d| filter_dir(d, @letters) })
+      wrapped_with_score(directories).sort.map(&:to_s)
     end
 
-    def dispersion(dir)
-      return 0 if dir.empty? || @letters.empty?
-      indices = []
-      d = dir.dup
+    def distance(dir)
+      scanner = StringScanner.new(dir)
       @letters.each do |letter|
-        idx = d.index(letter)
-        indices << idx
-        d = d[(idx + 1)..-1]
-      end
-      indices.inject(0, &:+) - indices.first
-    end
-
-    private
-
-    def filter_dir(dir, letters)
-      if letters.empty?
-        true
-      else
-        letter = letters.first
-        i = dir.index(letter)
-        i && filter_dir(dir[(i + 1)..-1], letters[1..-1])
+        scanner.scan(/.*?[#{letter}]/) or return :no_score
       end
+      scanner.pos - @letters.length
     end
 
-    def sort(directories)
-      directories.sort do |d1, d2|
-        disp1 = dispersion(d1)
-        disp2 = dispersion(d2)
-        if disp1 < disp2
-          -1
-        elsif disp1 > disp2
-          1
-        else
-          if d1.length < d2.length
-            -1
-          elsif d1.length > d2.length
-            1
-          else
-            0
-          end
-        end
-      end
+    def wrapped_with_score(directories)
+      directories.map { |d| DirWithScore.new(d, distance(d)) }.reject { |d| d.score == :no_score }
     end
+    private :wrapped_with_score
   end
+
 end
 

data/lib/prj/finder.rb

@@ -1,9 +1,11 @@
 require 'find'
 
 module Prj
+
   class Finder
-    def initialize(root)
+    def initialize(root, vcs_directories)
       @root = File.expand_path(root)
+      @vcs_directories = Array(vcs_directories)
     end
 
     ##
@@ -12,9 +14,12 @@ module Prj
     def find_project_directories
       subdirectories = []
       Find.find(@root) do |d|
-        subdirectories << d && Find.prune if File.exists?(File.join(d, ".git/"))
+        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

data/lib/prj.rb

@@ -1,8 +1,10 @@
 module Prj
   version_file = File.expand_path('../VERSION', File.dirname(__FILE__))
   VERSION = File.read(version_file).freeze
-end
 
-require 'prj/filter'
-require 'prj/finder'
+  autoload :DirWithScore, 'prj/dir_with_score'
+  autoload :Filter,       'prj/filter'
+  autoload :Finder,       'prj/finder'
+  autoload :App,          'prj/app'
+end
 

data/spec/acceptance/app_spec.rb

@@ -1,58 +1,62 @@
 require 'spec_helper'
-require 'prj/app'
-require 'stringio'
-require 'tmpdir'
+require 'fakefs/spec_helpers'
 require 'fileutils'
+require 'prj'
+require 'stringio'
+require 'yaml'
 
 describe "Prj::App" do
-  around(:each) do |example|
-    Dir.mktmpdir do |root|
-      @root = root
-      @subdirectories = [
-        "foo/.git/",
-        "bar/",
-        "baz/qux/crisp/.git/",
-        "baz/craps/poops/.git/",
-        "any/thing/here/"
-      ].map { |d| File.join(@root, d) }
-      @subdirectories.each { |d| FileUtils.mkdir_p(d) }
-      @sink = StringIO.new
-      example.run
-    end
+  include FakeFS::SpecHelpers
+
+  let(:output) { StringIO.new }
+  let(:root) { "/Projects" }
+  let(:subdirectories) do
+    [
+      "foo/.git/",
+      "bar/",
+      "baz/qux/crisp/.git/",
+      "baz/craps/poops/.git/",
+      "any/thing/here/"
+    ].map { |d| File.join(root, d) }
   end
 
-  context "with default projcts root" do
-    around(:each) do |example|
-      with_projects_root(@root) do
-        example.run
-      end
-    end
+  before(:each) do
+    FileUtils.mkdir_p(root)
+    subdirectories.each { |d| FileUtils.mkdir_p(d) }
+  end
 
+  context "with default projcts root" do
     it "prints matching directory and returns 0" do
-      Prj::App.new(@sink, ["ap"]).run.should == 0
-      @sink.string.chomp.should == File.join(@root, "baz/craps/poops")
+      with_config("projects_root" => root) do
+        Prj::App.new(output, ["ap"]).run.should == 0
+        output.string.chomp.should == File.join(root, "baz/craps/poops")
+      end
     end
 
     it "prints projects root and returns 0 if directory not found" do
-      Prj::App.new(@sink, ["nothingtofind"]).run.should == 0
-      @sink.string.chomp.should == @root + "/"
+      with_config("projects_root" => root) do
+        Prj::App.new(output, ["nothingtofind"]).run.should == 0
+        output.string.chomp.should == root + "/"
+      end
     end
+  end
 
+  it "uses ~/.prj.yml as config file" do
+    Prj::App.config_path.should == File.expand_path("~/.prj.yml")
   end
 
-  it "Uses project root from config if available" do
-    File.should_receive(:read).with(File.expand_path("~/.prj"))
-    Prj::App.new(@sink, ["something"]).run.should == 0
+  it "defaults to ~/Projects as default projects root" do
+    Prj::App.new(output, ["asdf"]).config.fetch("projects_root").should == File.expand_path("~/Projects")
   end
 
-  def with_projects_root(root)
-    tmp = Prj::App.default_projects_root
-    Prj::App.default_projects_root = root
-    Prj::App.ignore_config = true
+  def with_config(config = {})
+    tmp = Prj::App.config_path
+    config_path = ".prj.yml"
+    File.open(config_path, "w") { |f| f.write YAML.dump(config) }
+    Prj::App.config_path = config_path
     yield
-    Prj::App.default_projects_root = tmp
-    Prj::App.ignore_config = false
+  ensure
+    Prj::App.config_path = tmp
   end
 end
 
-

data/spec/lib/prj/filter_spec.rb

@@ -6,10 +6,10 @@ describe "Prj::Filter" do
     Prj::Filter.new(letters)
   end
 
-  describe "#dispersion" do
-    it "should calculate dispersion as difference between character positions except first character position" do
-      filter(%w(f o)).dispersion("foo bar").should == 0
-      filter(%w(f b)).dispersion("foo bar").should == 3
+  describe "#distance" do
+    it "should calculate distance as difference between character positions except first character position" do
+      filter(%w(f o)).distance("foo bar").should == 0
+      filter(%w(f b)).distance("foo bar").should == 3
     end
   end
 
@@ -19,6 +19,11 @@ describe "Prj::Filter" do
       filter(%w(f o)).filter(dirs).should == ["foos"]
     end
 
+    it "filters out non-satisfying entries" do
+      dirs = ["foos", "bars", "quxs"]
+      filter(%w(f o o q x b d u)).filter(dirs).should == []
+    end
+
     it "counts same chars correctly" do
       dirs = ["solar studio", "mars maraphone", "way too complex", "totla madness"]
       filter(%w(s s)).filter(dirs).should =~ ["solar studio", "totla madness"]
@@ -29,12 +34,12 @@ describe "Prj::Filter" do
       filter(%w(m a d n e)).filter(dirs).should =~ ["totla madness"]
     end
 
-    it "sorts by dispersion" do
+    it "sorts by distance" do
       dirs = ["/koans/", "/omniauth/", "/ruby-download/"]
       filter(%w(o a)).filter(dirs).should == ["/koans/", "/omniauth/", "/ruby-download/"]
     end
 
-    it "sorts by length for lines when dispersion is same" do
+    it "sorts by length for lines when distance is same" do
       dirs = ["/franchise/", "/granny/"]
       filter(%w(a n)).filter(dirs).should == ["/granny/", "/franchise/"]
 

data/spec/lib/prj/finder_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'fakefs/spec_helpers'
+require 'fileutils'
 require 'prj/finder'
 
 describe "Prj::Finder" do
@@ -9,18 +10,25 @@ describe "Prj::Finder" do
 
   it "finds directories containing .git/ scoped to given root and returns their relative paths" do
     make_directories(root, "/foo/.git", "/bar/qux", "/baz/.git")
-    Prj::Finder.new(root).find_project_directories.should =~ ["/foo", "/baz"]
+    finder(".git").find_project_directories.should =~ ["/foo", "/baz"]
   end
 
   it "does not find directories nested under directory containing .git/" do
     make_directories(root, "/foo/.git", "/foo/bar", "/foo/baz/.git")
-    Prj::Finder.new(root).find_project_directories.should =~ ["/foo"]
+    finder(".git").find_project_directories.should =~ ["/foo"]
+  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"]
   end
 
   def make_directories(root, *directories)
-    directories.each do |d|
-      FakeFS::FileSystem.add(File.join(root, d))
-    end
+    directories.each { |d| FileUtils.mkdir_p(File.join(root, d)) }
+  end
+
+  def finder(*vcs_directories)
+    Prj::Finder.new(root, vcs_directories)
   end
 end
 

data/spec/spec_helper.rb

@@ -17,5 +17,3 @@ require 'rspec/autorun'
 
 $:.unshift File.expand_path('../../lib', __FILE__)
 
-Dir[File.dirname(__FILE__) + "/support/matchers/*.rb"].each {|f| require f}
-

metadata

@@ -1,18 +1,24 @@
 --- !ruby/object:Gem::Specification
 name: prj
 version: !ruby/object:Gem::Version
-  version: 0.0.1
   prerelease: 
+  version: 0.0.2
 platform: ruby
 authors:
 - Vladimir Yarotsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-22 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -21,14 +27,14 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: rake
+        version: '0.9'
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -37,14 +43,14 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
+- !ruby/object:Gem::Dependency
+  name: simplecov
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+        version: '0.6'
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -53,14 +59,14 @@ 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.6'
-- !ruby/object:Gem::Dependency
-  name: fakefs
+        version: '0.4'
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -69,12 +75,6 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.4'
 description: ! '    Prj is an utility to quickly go to project directory using fuzzy
   matching
 
@@ -87,6 +87,7 @@ 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.rb
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Fuzzy-matching project finder