rprompt 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rprompt.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Olivier Robert
+
+MIT License
+
+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.md

@@ -0,0 +1,77 @@
+# rprompt
+
+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 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.
+
+## Usage
+
+The prompt is customizable via a yaml file that enables you to:
+
+* choose the options you want to see
+* set your standard unix prompt
+* set your git prompt
+* set your rvm prompt
+* change the layout of what goes where
+* change the symbols to identify options
+* change colors (all colors provided by the term-ansicolor gem)
+
+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
+
+The prompt may look like the following:
+
+* ``(master↑3|✚1)``: on branch ``master``, ahead of remote by 3 commits, 1 file changed but not staged
+* ``(status|●2)``: on branch ``status``, 2 files staged
+* ``(master|✚7…)``: on branch ``master``, 7 files changed, some files untracked
+* ``(master|✖2✚3)``: on branch ``master``, 2 conflicts, 3 files changed
+* ``(experimental↓2↑3|✔)``: on branch ``experimental``; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean
+
+The symbols are as follows:
+
+- Local Status Symbols
+  - ``✔``: repository clean
+  - ``●n``: there are ``n`` staged files
+  - ``✖n``: there are ``n`` unmerged files
+  - ``✚n``: there are ``n`` changed but *unstaged* files
+  - ``…n``: there are ``n`` untracked files
+- Branch Tracking Symbols
+  - ``↑n``: ahead of remote by ``n`` commits
+  - ``↓n``: behind remote by ``n`` commits
+
+### Rvm examples
+
+* ∆1.9.3-p448: ruby version 1.9.3
+* ›global: using the global gemset
+
+## Installation
+
+	$ gem install rprompt
+
+Once the gem is installed,
+
+	$ rpromptconf
+
+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
+
+		---
+		# Setting terminal promt with rprompt gem
+		PROMPT_COMMAND="$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')
+
+Enjoy :\))

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/rprompt

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+#encoding: utf-8
+
+require 'YAML'
+require 'rprompt'
+
+configFile = "#{File.expand_path('~')}/.rprompt/config.yml"
+begin
+	config = YAML.load_file configFile
+rescue => err
+	puts err.message
+	puts "Please run 'rPrompt config' to create the initial configuration.\n> " #TODO
+	exit
+end
+
+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
+
+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
+		gitLayout.gsub!(/staged|modified|untracked|unmerged/, '')
+		gitLayout.gsub!(/allgood/, "✔".send(:green)) if gitLayout.include?("allgood")
+	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")
+	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")
+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")
+end
+
+prompt = "#{stdPrompt[:start]}#{gitLayout} #{rvmLayout}#{stdPrompt[:end]}"
+print prompt

data/bin/rpromptconf

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+todo = %Q(rprompt standard configuration has been created.
+
+To make the magic happen:
+1/ edit your ~/.bashrc or ~/.bash_profile
+(depending on your preferences and setup)
+2/ if you're setting PS1 already, comment it while you're using rprompt
+3/ paste the following lines between '---' at the end of the file
+
+---
+# Setting terminal promt with rprompt gem
+PROMPT_COMMAND="$PROMPT_COMMAND PS1=\\"\\$(rprompt)\\";"
+---
+
+4/ 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')
+
+Enjoy :\))
+
+src = File.expand_path(File.join(File.dirname(__FILE__), '..', 'files/config.yml'))
+home = File.expand_path('~')
+dest = File.join(home, '.rprompt')
+begin
+	FileUtils.mkdir(dest) if !File.exists?(dest)
+	FileUtils.cp src, dest
+	puts todo
+rescue => err
+	puts "Oops, something went wrong: " + err.message
+end

data/files/config.yml

@@ -0,0 +1,63 @@
+##### Standard Prompt #####
+
+:stdprompt:
+  # current working directory
+  :start: '\[\033[0;32m\]\w\[\033[0m\] '
+
+  # Military time
+  :end: '\n\A \$ '
+
+
+##### Git Prompt #####
+
+:git:
+  :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
+
+:rvm:
+  :ruby:
+    :cmd: rvm-prompt
+    :color: red
+    :symbol: ∆
+
+  :gemset:
+    :cmd: rvm-prompt
+    :color: yellow
+    :symbol: ›
+
+  :layout: ruby gemset

data/lib/rprompt/version.rb

@@ -0,0 +1,3 @@
+module Rprompt
+  VERSION = "0.0.2"
+end

data/lib/rprompt.rb

@@ -0,0 +1,151 @@
+require "rprompt/version"
+
+require "term/ansicolor"
+# Usage as Mixin into String or its Subclasses
+class String
+  include Term::ANSIColor
+end
+
+module Rprompt
+	class PromptItem
+
+		# @return [String] symbol character to identify prompt item
+		attr_reader :symbol, :color
+
+		# @param config [Hash] Prompt item configuration:
+		# 	- :cmd => shell command
+		# 	- :symbol => character
+		# 	- :color => color name
+		def initialize(config)
+			@cmd        = config[:cmd]
+			@symbol     = config[:symbol]
+			@color      = config[:color]
+		end
+
+		# executes prompt item command
+		# @return [String] command result
+		def commandResult
+			%x(#{@cmd} 2> /dev/null)
+		end
+	end
+
+	class GitNumbers < PromptItem
+		# @return [Integer] number of files returned by a git command
+		def numberOfFiles
+			commandResult.split(/\r?\n/).count
+		end
+
+		# @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
+		end
+	end
+
+	class GitBranch < PromptItem
+		# @return [String] branch name
+		def shortBranchName
+			commandResult.chomp.split('/').last
+		end
+
+		# @return [String] terminal representation of the branch name
+		def show
+			if color
+				"#{symbol}#{shortBranchName}".send(color)
+			else
+				"#{symbol}#{shortBranchName}"
+			end
+		end
+	end
+
+	class GitSha < PromptItem
+		# @return [String] last five numbers form the sha1
+		def sha
+			commandResult.chomp[-6,6]
+		end
+
+		# @return [String] terminal representation of the number returned by 'sha'
+		def show
+			if color
+				"#{symbol}#{sha}".send(color)
+			else
+				"#{symbol}#{sha}"
+			end
+		end
+	end
+
+	class GitTrack < PromptItem
+		# @param (see PromptItem#initialize)
+		# @param [Symbol] state ("ahead" or "behind")
+		def initialize(config, state)
+			@state = state
+			super(config)
+		end
+
+		# @return [Integer] number of commits ahead or behind remote
+		# @note works only if remote branch is tracked
+		def count
+			commandResult.match(/#{@state}\s+([0-9]+)/)
+			$1.to_i
+		end
+
+		# @return [String] terminal representation of the tracking
+		def show
+			if color
+				count != 0 ? "#{symbol}#{count}".send(color) : ""
+			else
+				count != 0 ? "#{symbol}#{count}" : ""
+			end
+		end
+	end
+
+	class RvmRuby < PromptItem
+		# @return [String] ruby used
+		def ruby
+			text = commandResult.chomp
+			if text.include?('@')
+				text.match(/ruby-(.+)@/)[1]
+			else
+				text.gsub!(/ruby-/, '')
+			end
+		end
+
+		# @return [String] terminal representation of the ruby version
+		def show
+			if color
+				"#{symbol}#{ruby}".send(color)
+			else
+				"#{symbol}#{ruby}"
+			end
+		end
+	end
+
+	class RvmGemset < PromptItem
+		# @return [String] gemset used
+		def gemset
+			text = commandResult.chomp
+			if text.include?('@')
+				text.match(/.+@(.+)/)[1]
+			else
+				''
+			end
+		end
+
+		# @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
+		end
+	end
+
+end

data/rprompt.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rprompt/version'
+
+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.summary       = %q{rprompt}
+  spec.homepage      = "https://github.com/olibob/rprompt.git"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "term-ansicolor"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: rprompt
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Olivier Robert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: term-ansicolor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'Adds usefull information to your bash prompt, '
+email:
+- robby57@gmail.com
+executables:
+- rprompt
+- rpromptconf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rprompt
+- bin/rpromptconf
+- files/config.yml
+- lib/rprompt.rb
+- lib/rprompt/version.rb
+- rprompt.gemspec
+homepage: https://github.com/olibob/rprompt.git
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: rprompt
+test_files: []
+has_rdoc: