rprompt 0.0.4 → 0.0.5

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .yardoc
+doc
 Gemfile.lock
 InstalledFiles
 _yardoc

data/README.md

@@ -3,10 +3,12 @@
 
 Pimp your prompt :-)
 
-This prompt is a shameless port (and enhancement) of the "Informative git prompt for bash and fish" which you can find [here](https://github.com/magicmonty/bash-git-prompt.git)
+This prompt is a shameless port (and enhancement) of the "Informative git prompt for bash and fish" which you can find [here](https://github.com/magicmonty/bash-git-prompt.git).
 
 This gem is targeted toward users who use ruby, rvm and git. It will improve your ``bash`` prompt by displaying information about the current git repository or the rvm ruby version and gemset.
 
+  ![an inline image](files/rprompt.png "rprompt in action")
+
 ## Usage
 
 The prompt is customizable via a yaml file that enables you to:
@@ -21,7 +23,26 @@ The prompt is customizable via a yaml file that enables you to:
 
 Using the layout is actually very easy: throw the name of the options around, add white spaces, delimiters, etc... Save, hit enter in your shell, done!
 
-### Git examples
+## Tips
+
+A few recommandations to make your life easier ;)
+
+* Install this gem in your **global** gemset. This way, rprompt will be available everywhere, whatever gemset you're using
+
+* When upgrading save your config file and create a new one with ``rpromptconf`` (specially for minor and major releases)
+
+* If you edit the config.yml file with vi and can not see the symbols characters correctly, try ``:set encoding=utf-8`` (you might want to put this in your ``.vimrc``)
+
+* If you don't want a fancy symbol or color, but still want the option use ``:none``
+
+        :modified:
+          :none:
+
+* The layout is just a string of option names (status , modified, staged ...) concatenated in the order you want them to appear, with or without white spaces, or what ever you characters you choose.
+
+* Report bugs ;)
+
+## Git examples
 
 The prompt may look like the following:
 
@@ -43,37 +64,38 @@ The symbols are as follows:
   - ``↑n``: ahead of remote by ``n`` commits
   - ``↓n``: behind remote by ``n`` commits
 
-### Rvm examples
+## Rvm examples
 
 * ∆1.9.3-p448: ruby version 1.9.3
 * ›global: using the global gemset
 
 ## Installation
 
-	$ gem install rprompt
+``$ gem install rprompt``
 
 Once the gem is installed,
 
-	$ rpromptconf
+``$ rpromptconf``
 
-This will provide a standard config file: ```$HOME/.rprompt/config.yml```
+This will provide a standard config file: `$HOME/.rprompt/config.yml`
 
 To make the magic happen:
 
 * edit your ~/.bashrc or ~/.bash_profile
 (depending on your preferences and setup)
 * if you're setting PS1 already, comment it while you're using rprompt
-* paste the following lines between '---' at the end of the file
+* paste the following line at the end of the file
+
+    ``PROMPT_COMMAND="PS1=\"\$(rprompt)\";"``
 
-    Tested on MacOS 10.8.4
-		---
-		# Setting terminal promt with rprompt gem
-		PROMPT_COMMAND="PS1=\"\$(rprompt)\";"
-		---
 
 * quit your terminal and re-open it for the change to take effect.
 
 Edit $HOME/.rprompt/config.yml to change the configuration.
-(you can always re-install the default configuration by issuing 'rpromptconf')
+(you can always re-install the default configuration by issuing ``rpromptconf``)
+
+Enjoy :\)
+
+---
 
-Enjoy :\))
+<sub>Tested on MacOS 10.8.4 and Fedora 19</sub>

data/bin/rprompt

@@ -3,6 +3,7 @@
 
 require 'yaml'
 require 'rprompt'
+require 'pp'
 
 configFile = "#{File.expand_path('~')}/.rprompt/config.yml"
 begin
@@ -13,49 +14,105 @@ rescue => err
 	exit
 end
 
+if config.class == Hash
 stdPrompt = config[:stdprompt] if config.has_key?(:stdprompt)
 gitConfig = config[:git] if config.has_key?(:git)
 gitLayout = gitConfig[:layout] if gitConfig
 rvmConfig = config[:rvm] if config.has_key?(:rvm)
 rvmLayout = rvmConfig[:layout] if rvmConfig
+else
+	puts "rprompt config seems to be empty?"
+	print '\u@\h $'
+	exit 1
+end
+
+if File.exist?(".git") && gitConfig && gitLayout
+	if gitConfig[:status]
+		status =  Rprompt::GitNumbers.new(gitConfig[:status].merge({:cmd => "git status -s"}))
+	else
+		status = Rprompt::GitNumbers.new({:cmd => "git status -s"})
+	end
 
-if File.exist?(".git") && gitConfig
-	staged    = Rprompt::GitNumbers.new(gitConfig[:staged])
-	modified  = Rprompt::GitNumbers.new(gitConfig[:modified])
-	untracked = Rprompt::GitNumbers.new(gitConfig[:untracked])
-	unmerged  = Rprompt::GitNumbers.new(gitConfig[:unmerged])
-	branch    = Rprompt::GitBranch.new(gitConfig[:branch])
-	ahead     = Rprompt::GitTrack.new(gitConfig[:ahead], "ahead")
-	behind    = Rprompt::GitTrack.new(gitConfig[:behind], "behind")
-	sha       = Rprompt::GitSha.new(gitConfig[:sha])
-
-	if staged.numberOfFiles == 0 && untracked.numberOfFiles == 0 && unmerged.numberOfFiles == 0 && modified.numberOfFiles == 0
+	if status.numberOfFiles == 0
 		gitLayout.gsub!(/staged|modified|untracked|unmerged/, '')
-		gitLayout.gsub!(/allgood/, "✔".send(:green)) if gitLayout.include?("allgood")
+		gitLayout.gsub!(/status/, "✔".send(:green)) if gitLayout.include?("status")
+	else
+		if gitConfig[:staged]
+			staged    = Rprompt::GitNumbers.new(gitConfig[:staged].merge({:cmd => "git diff --staged --name-status"}))
+			gitLayout.gsub!(/staged/, staged.show) if gitLayout.include?("staged")
+		else
+			gitLayout.gsub!(/staged/, '')
+		end
+
+		if gitConfig[:modified]
+			modified  = Rprompt::GitNumbers.new(gitConfig[:modified].merge({:cmd => "git diff --name-status"}))
+			gitLayout.gsub!(/modified/, modified.show) if gitLayout.include?("modified")
+		else
+			gitLayout.gsub!(/modified/, '')
+		end
+
+		if gitConfig[:untracked]
+			untracked = Rprompt::GitNumbers.new(gitConfig[:untracked].merge({:cmd => "git ls-files --other --exclude-standard"}))
+			gitLayout.gsub!(/untracked/, untracked.show) if gitLayout.include?("untracked")
+		else
+			gitLayout.gsub!(/untracked/, '')
+		end
+
+		if gitConfig[:unmerged]
+			unmerged  = Rprompt::GitNumbers.new(gitConfig[:unmerged].merge({:cmd => "git diff --name-status --diff-filter=U"}))
+			gitLayout.gsub!(/unmerged/, unmerged.show) if gitLayout.include?("unmerged")
+		else
+			gitLayout.gsub!(/unmerged/, '')
+		end
+
+		gitLayout.gsub!(/status/, "") if gitLayout.include?("status")
+	end
+
+	if gitConfig[:branch]
+		branch    = Rprompt::GitBranch.new(gitConfig[:branch].merge({:cmd => "git symbolic-ref HEAD"}))
+		gitLayout.gsub!(/branch/, branch.show) if gitLayout.include?("branch")
 	else
-		gitLayout.gsub!(/allgood/, '') if gitLayout.include?("allgood")
-		gitLayout.gsub!(/staged/, staged.show) if gitLayout.include?("staged")
-		gitLayout.gsub!(/modified/, modified.show) if gitLayout.include?("modified")
-		gitLayout.gsub!(/untracked/, untracked.show) if gitLayout.include?("untracked")
-		gitLayout.gsub!(/unmerged/, unmerged.show) if gitLayout.include?("unmerged")
+		gitLayout.gsub!(/branch/, '')
 	end
 
-	gitLayout.gsub!(/branch/, branch.show) if gitLayout.include?("branch")
-	gitLayout.gsub!(/sha/, sha.show) if gitLayout.include?("sha")
-	gitLayout.gsub!(/ahead/, ahead.show) if gitLayout.include?("ahead")
-	gitLayout.gsub!(/behind/, behind.show) if gitLayout.include?("behind")
+	if gitConfig[:ahead]
+		ahead     = Rprompt::GitTrack.new(gitConfig[:ahead].merge({:cmd => "git branch -v"}), "ahead")
+		gitLayout.gsub!(/ahead/, ahead.show) if gitLayout.include?("ahead")
+	else
+		gitLayout.gsub!(/ahead/, '')
+	end
+
+	if gitConfig[:behind]
+		behind    = Rprompt::GitTrack.new(gitConfig[:behind].merge({:cmd => "git branch -v"}), "behind")
+		gitLayout.gsub!(/behind/, behind.show) if gitLayout.include?("behind")
+	else
+		gitLayout.gsub!(/behind/, '')
+	end
+	if gitConfig[:sha]
+		sha       = Rprompt::GitSha.new(gitConfig[:sha].merge({:cmd => "git rev-parse HEAD"}))
+		gitLayout.gsub!(/sha/, sha.show) if gitLayout.include?("sha")
+	else
+		gitLayout.gsub!(/sha/, '')
+	end
 else
 	gitLayout = ''
 end
 
 # RVM
 
-if rvmConfig
-	ruby = Rprompt::RvmRuby.new(rvmConfig[:ruby])
-	gemset = Rprompt::RvmGemset.new(rvmConfig[:gemset])
-
-	rvmLayout.gsub!(/ruby/, ruby.show) if rvmLayout.include?("ruby")
-	rvmLayout.gsub!(/gemset/, gemset.show) if rvmLayout.include?("gemset")
+if rvmConfig && rvmLayout
+	if rvmConfig[:ruby]
+		ruby = Rprompt::RvmRuby.new(rvmConfig[:ruby].merge({:cmd => "rvm-prompt"}))
+		rvmLayout.gsub!(/ruby/, ruby.show) if rvmLayout.include?("ruby")
+	else
+		rvmLayout.gsub!(/ruby\s+/, '')
+	end
+	if rvmConfig[:gemset]
+		gemset = Rprompt::RvmGemset.new(rvmConfig[:gemset].merge({:cmd => "rvm-prompt"}))
+		rvmLayout.gsub!(/gemset/, gemset.show) if rvmLayout.include?("gemset")
+	else
+		rvmLayout.gsub!(/gemset/, '')
+	end
 end
 
 prompt = "#{stdPrompt[:start]}#{gitLayout} #{rvmLayout}#{stdPrompt[:end]}"

data/files/config.yml

@@ -11,52 +11,46 @@
 ##### Git Prompt #####
 
 :git:
+  :status:
+    :color: green
+    :symbol: ✔
+
   :staged:
-    :cmd: git diff --staged --name-status
     :symbol: ●
     :color: red
 
   :untracked:
-    :cmd: git ls-files --other --exclude-standard
     :symbol: …
 
   :modified:
-    :cmd: git diff --name-status
     :symbol: ✚
     :color: blue
 
   :unmerged:
-    :cmd: git diff --name-status --diff-filter=U
     :symbol: ✖
     :color: yellow
 
   :ahead:
-    :cmd: git branch -v
     :symbol: ↑
 
   :behind:
-    :cmd: git branch -v
     :symbol: ↓
 
   :sha:
-    :cmd: git rev-parse HEAD
     :symbol: '#'
     :color: yellow
 
   :branch:
-    :cmd: git symbolic-ref HEAD
     :color: magenta
 
-  :layout: (branchbehindahead|stagedmodifieduntrackedunmergedallgood) sha
+  :layout: (branchbehindahead|stagedmodifieduntrackedunmergedstatus) sha
 
 :rvm:
   :ruby:
-    :cmd: rvm-prompt
     :color: red
     :symbol: ∆
 
   :gemset:
-    :cmd: rvm-prompt
     :color: yellow
     :symbol: ›
 

data/lib/rprompt.rb

@@ -1,13 +1,10 @@
 require "rprompt/version"
-
-require "term/ansicolor"
-# Usage as Mixin into String or its Subclasses
-class String
-  include Term::ANSIColor
-end
+require "rprompt/deco"
+require "rprompt/termcolor"
 
 module Rprompt
 	class PromptItem
+		include Deco
 
 		# @return [String] symbol character to identify prompt item
 		attr_reader :symbol, :color
@@ -37,11 +34,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the number of files
 		def show
-			if color
-				numberOfFiles != 0 ? "#{symbol}#{numberOfFiles}".send(color) : ""
-			else
-				numberOfFiles != 0 ? "#{symbol}#{numberOfFiles}" : ""
-			end
+			numberOfFiles != 0 ? termShow({:color => color, :symbol => symbol, :content => numberOfFiles}) : ''
 		end
 	end
 
@@ -53,11 +46,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the branch name
 		def show
-			if color
-				"#{symbol}#{shortBranchName}".send(color)
-			else
-				"#{symbol}#{shortBranchName}"
-			end
+			termShow({:color => color, :symbol => symbol, :content => shortBranchName})
 		end
 	end
 
@@ -69,11 +58,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the number returned by 'sha'
 		def show
-			if color
-				"#{symbol}#{sha}".send(color)
-			else
-				"#{symbol}#{sha}"
-			end
+			termShow({:color => color, :symbol => symbol, :content => sha})
 		end
 	end
 
@@ -94,11 +79,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the tracking
 		def show
-			if color
-				count != 0 ? "#{symbol}#{count}".send(color) : ""
-			else
-				count != 0 ? "#{symbol}#{count}" : ""
-			end
+			count != 0 ? termShow({:color => color, :symbol => symbol, :content => count}) : ''
 		end
 	end
 
@@ -115,11 +96,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the ruby version
 		def show
-			if color
-				"#{symbol}#{ruby}".send(color)
-			else
-				"#{symbol}#{ruby}"
-			end
+			termShow({:color => color, :symbol => symbol, :content => ruby})
 		end
 	end
 
@@ -136,15 +113,7 @@ module Rprompt
 
 		# @return [String] terminal representation of the gemset used
 		def show
-			if !gemset.empty?
-				if color
-					"#{symbol}#{gemset}".send(color)
-				else
-					"#{symbol}#{gemset}"
-				end
-			else
-				''
-			end
+			!gemset.empty? ? termShow({:color => color, :symbol => symbol, :content => gemset}) : ''
 		end
 	end
 

data/lib/rprompt/deco.rb

@@ -0,0 +1,21 @@
+module Deco
+	def termShow(args)
+		color = args[:color]
+		symbol = args[:symbol]
+		content = args[:content]
+
+		if color
+				if symbol
+					"#{symbol}#{content}".send(color)
+				else
+					"#{content}".send(color)
+				end
+			else
+				if symbol
+					"#{symbol}#{content}"
+				else
+					"#{content}"
+				end
+			end
+	end
+end

data/lib/rprompt/termcolor.rb

@@ -0,0 +1,5 @@
+require "term/ansicolor"
+# Usage as Mixin into String or its Subclasses
+class String
+  include Term::ANSIColor
+end

data/lib/rprompt/version.rb

@@ -1,3 +1,3 @@
 module Rprompt
-  VERSION = "0.0.4"
-end
+  VERSION = "0.0.5"
+end

data/rprompt.gemspec

@@ -2,13 +2,15 @@
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'rprompt/version'
+require 'rprompt/deco'
+require 'rprompt/termcolor'
 
 Gem::Specification.new do |spec|
   spec.name          = "rprompt"
   spec.version       = Rprompt::VERSION
   spec.authors       = ["Olivier Robert"]
   spec.email         = ["robby57@gmail.com"]
-  spec.description   = %q{Adds usefull information to your bash prompt, }
+  spec.description   = %q{Adds usefull information to your bash prompt}
   spec.summary       = %q{rprompt}
   spec.homepage      = "https://github.com/olibob/rprompt.git"
   spec.license       = "MIT"