git-hack 0.0.3 → 0.0.5

data/README.md

@@ -1,9 +1,9 @@
 # git-hack
 
-I don't known why logic of git is sooooo horrible!! And I make this tools for people to say "WOW,This is git !!!"
+目标是制作一个简单易用的git 工具
 
-0. git-save git-redo git-undo git-backto They look easy to understand? Wow,This is git. 
-1. 
+0. git-save git-redo git-undo git-backto They look easy to understand?  
+1. remote comming son..
 
 
 ## Installing
@@ -14,12 +14,16 @@ All you need to do is grab the gem:
 
 
 ### save
+		git save "msg"
 
 ### undo
+		git undo                     # 回到上一个提交
 
 ### redo
+		git redo 										# 前进到下一个提交
 
 ### backto
+		git backto [number]         # 跳到指定的提交
 
 ## Copyright
 

data/bin/git-goto

@@ -2,4 +2,4 @@
 
 require (File.expand_path('../../lib/git-hack', __FILE__))
 
-GitHack::GitRepo.new(".").git_goto(ARGV.first)
+GitHack::GitRepo.new(".").goto(ARGV.first.to_i)

data/bin/git-minilog

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require (File.expand_path('../../lib/git-hack', __FILE__))
+require 'awesome_print'
+
+GitHack::GitRepo.new(".").show_commits

data/lib/core_ext/git_patch.rb

@@ -6,7 +6,7 @@
 module Git
 	class Lib
 		def full_log_commits(opts = {})
-			arr_opts = ['--pretty=raw']
+			arr_opts = ['--no-color --pretty=raw']
 			arr_opts << "-#{opts[:count]}" if opts[:count]
 			arr_opts << "--skip=#{opts[:skip]}" if opts[:skip]
 			arr_opts << "--since=#{opts[:since]}" if opts[:since].is_a? String

data/lib/core_ext/line_builder.rb

@@ -1,15 +1,23 @@
-#
-# 把文本转化成对象的Build模式
-#
+# Copyright @ weizhao 2012
+# 把线性数据转化成对象的线性构造器
+# 给定@data,@index就可以从 #object #all_object 方法中得到构造到的对象
+# 一般需要重写 #process_line 行处理函数
+# 			   #out? 退出条件处理函数
 #
 class LineBuilder
-	attr_accessor :data,:index,:object
+	attr_accessor :data,:index
 	def initialize(data,index=0)
-		@data = data
-		@index = index
-		@object = nil
-		@is_parse = false
+		@data = data 			# 要处理的array数据
+		@index = index 			# 处理数据的位置,从0起
+		@data_size = data.size  # 这个会经常调用 
+		@object = nil   		# 保存要构造的对象,调用#parse后可以使用
+		@all_objects = nil 		# 保存所有能构造的对象, 调用#find_all后使用
+		@is_parse = false  # 是否解析过的标志
 	end
+
+	#
+	# parse 分析函数,最好不要重写,一般这可就可以了
+	#
 	def parse
 		@is_parse = true
 		return nil if is_over?
@@ -19,37 +27,53 @@ class LineBuilder
 		end until (  out? || is_over?)
 		self
 	end
+	#
 	# 行处理函数,必须被重写
+	# 默认是读一行,把数据做为对象传给object
+	#
 	def process_line
 		line = @data[@index]
 		@object = line
 	end
+	def object
+		@object ||= parse.object
+	end
+	def all_objects
+		@all_objects ||= find_all.collect { |b| b.object } 
+	end
+	#
 	# 进入条件,默认直接进入
+	#
 	def in?
 		true
 	end
+	#
 	# 退出条件,默认为读完本行直接退出,重写要设置@index的新值
+	# 即线性构造器每次只取一行
+	#
 	def out?
 		@index += 1
 	end
-	# 是否数据结构
+	# 是否数据已经遍历结束
 	def is_over?
-		@index >= @data.size
+		@index >= @data_size
 	end
+	# 得到下一个数据
+	# 运行两次不会得到下一个的下一个数据
 	def get_next
 		return nil if is_over?
 		return self.class.new(@data,@index).parse
 	end
-	# 得出剩下的
+	# 得到剩下的数据
 	def rest
 		return [] if is_over?
 		next_b = get_next
-		return [next_b] + ( next_b.is_over? ? [] : next_b.rest)
+		return [next_b] + next_b.rest #( next_b.is_over? ? [] : next_b.rest)
 	end
-	# 找出全部的
+	# 为@data结构全部的数据
 	def find_all
-		return [] if is_over? && @object == nil
+		return [] if is_over? && @object == nil  # 给定的index已经超出data
 		parse unless @is_parse
-		[self] + rest
+		@all_objects = [self] + rest
 	end
 end

data/lib/core_ext/save_execute.rb

@@ -0,0 +1,13 @@
+# 标记方法安全运行的模块
+#
+module SaveExecute
+	def ready_to_execute
+		@is_success = false
+	end
+	def execute_success
+		@is_success = true
+	end
+	def success?
+		@is_success
+	end
+end

data/lib/git-hack.rb

@@ -3,6 +3,8 @@ require "git"
 Dir["#{File.dirname(__FILE__)}/**/*.rb"].each { |f| require f }
 
 module GitHack
+	include PathCommon
+	include SaveExecute
 	def self.current
 		@current || get_dir('.')
 	end

data/lib/git-hack/commit.rb

@@ -1,10 +1,18 @@
-
+# Commit类对应git当中的提交对象
 require_relative "../git-hack"
 
 
 module GitHack
 	class Commit
-		attr_accessor :message,:sha
+		attr_accessor :message,:sha,:parent,:tree,:author,:committer
+		def initialize(hash)
+			@sha = hash['sha']
+			@message = hash['message']
+			@parent = hash['parent']
+			@tree = hash['tree']
+			@author = hash['author']
+			@committer = hash['committer']
+		end
 	end
 end
 

data/lib/git-hack/commit_facade.rb

@@ -0,0 +1,50 @@
+# CommitFacade 类提供一个对外的git commit的接口
+#
+require_relative "commit_line_builder"
+require_relative "simple_line_builder"
+
+module GitHack
+	class CommitFacade
+		def initialize(dir)
+			@dir = dir	
+			@commits = []
+		end
+		# 从log中取得当前commit之前的Commits
+		#
+		def get_log_commits
+			git = Git.open(@dir ,:log => Logger.new(STDOUT)) 
+			l = Git::Lib.new(git)
+			opts = ["--pretty=raw"]
+			data = l.command_lines_patch('log',opts)
+			return @commits = CommitLineBuilder.new(data,0).all_objects
+		end
+		def get_next_commit 
+			file = File.open("#{@dir}/.git/logs/HEAD")
+			data = []
+			file.each { |line|
+				data << line
+			}
+			commit_data = SimpleLineBuilder.new(data,0).find_all
+			commit = commit_data.find do |c| 
+				c.object == current_commit 
+			end
+			commit_sha = commit ?  commit.value : nil
+		end
+		def current_commit
+			@current_commit if @current_commit
+			data = data_from_file("#{@dir}/.git/HEAD")
+			commit_file_data = SimpleLineBuilder.new(data,0).parse
+			commit_file = commit_file_data.value
+			@current_commit = data_from_file("#{@dir}/.git/#{commit_file}")
+			@current_commit = @current_commit[0].chomp
+		end
+		def data_from_file(path)
+			file = File.open(path)
+			data = []
+			file.each { |line|
+				data << line
+			}
+			data 
+		end
+	end
+end

data/lib/git-hack/commit_line_builder.rb

@@ -1,11 +1,19 @@
-
+# CommitLineBuilder类用于得到库内的提交信息
+# 现阶段从git log命令得到主数据
 require_relative "../core_ext/line_builder"
+
+# git log 数据可能被加色,本补丁删除加色信息
 class String
 	def uncolorize
-		self.gsub(/\e\[(\d+)*m/,"")	
+		# BUG: 在bin/git* 下运行可以去掉,但是安装gem 后就不能了????
+		self.gsub(/\e\[(\d+)*m/,"")  # 以除 \e[30e]	 颜色标记
+	end
+end
+class Hash
+	def to_class(new_class)
+		return new_class.new(self)
 	end
 end
-
 
 module GitHack
 	class CommitLineBuilder < LineBuilder
@@ -16,40 +24,40 @@ module GitHack
 			@commit = { 'sha'=>nil, 'message' => '', 'parent' => [] }
 			@is_next_commit = false
 		end
+		# 重写#process_line
 		def process_line
-			@is_message
-			line = @data[@index]		
-			line = line.chomp.uncolorize
-			if line == ""
+			line = @data[@index].chomp.uncolorize
+			if line == ""          # msg信息以上下两个"" 分隔
 				@is_message = !@is_message
 			elsif @is_message
 				@commit['message'] << line+"\n"
 			else
-				data = line.split
-				@key = key = data.shift
-				@value = data.join(" ")
+				line_to_commit(line)
+			end
+			@object = @commit.to_class(Commit)
+		end
+		# 将每行的数据信息转换成Commit的信息
+		def line_to_commit(line)
+			data = line.split
+			key = data.shift
+			value = data.join(" ")
 
-				if @key == "commit"
-				 	if @commit['sha']
-						@is_next_commit = true
-					else
-						@commit['sha'] = @value
-					end
-				elsif @key == 'parent'
-					@commit[@key] << @value
+			if key == "commit"
+			 	if @commit['sha']  		# key第二次是commit时 设置是否下条信息的标志,见 #out?
+					@is_next_commit = true  
 				else
-					@commit[@key] = @value
+					@commit['sha'] = value
 				end
+			elsif key == 'parent'
+				@commit[key] << value
+			else
+				@commit[key] = value
 			end
-			@object = @commit
 		end
 		def out?
-			if @is_next_commit
-				return true
-			else
-				@index += 1
-				return false
-			end
+			# 如果已经到下一条commit,则为结束标志,并指针并不再移动
+			@index += 1 unless @is_next_commit
+			return @is_next_commit 
 		end
 	end
 end

data/lib/git-hack/git_repo.rb

@@ -3,7 +3,9 @@ require 'logger'
 require 'colorize'  
 require "ap"
 
+require_relative "../git-hack"
 require_relative "../core_ext/path"
+require_relative "../core_ext/save_execute"
 
 module GitHack
 	# GitRepo类拥有git的所有
@@ -11,34 +13,38 @@ module GitHack
 	#     work，即工作目录及文件 GitHack::WorkingDirectory类
 	#     remote，对应远程库信息 GitHack::Remote类
 	#
+	# 对外操作的函数:
+	#  # init(dir)
+	#  # goto(number)
+	#  # redo
+	#  # undo
+	#
 	class GitRepo < Git::Path
 		include PathCommon
+		include SaveExecute
+
 		attr_accessor :git,:commits,:work,:remote,:current_commit
+		
 		def initialize(path)
 			@workingdirectory = get_gitdir(path)	
-			@commits = []
+			@git = nil
+			@commits = nil
+			@commit_facade = nil
 		end
+
+		# 属性函数
 		def git
 			@git ||= Git.open(@workingdirectory ,:log => Logger.new(STDOUT)) 
 		end
-		def commits
-			return @commits if !@commits.empty?
-			l = Git::Lib.new(git)
-			opts = ["--pretty=raw"]
-			@data = l.command_lines_patch('log',opts)
-			return @commits = CommitLineBuilder.new(@data,0).find_all
-		end
-		# 得到本身或是上层目录中.git文件的路经
-		def get_gitdir(path)
-			git_path = absolute_path(path)
-			return nil if git_path == "/"
-			return git_path if is_gitdir?(git_path) 
-			return get_gitdir(join(git_path,"/../"))
+		def commit_facade
+			@commit_facade ||= CommitFacade.new(@workingdirectory)
 		end
-		def is_gitdir?(path)
-			File.directory?(join(path,".git")) ? true : false
+		def commits
+			@commits ||= commit_facade.get_log_commits
 		end
+		#
 		# 把工作目录的文件添加到git仓库并提交 
+		#
 		def git_save(msg,options={})
 			ready_to_execute
 			return self if not_git_directory?
@@ -47,61 +53,50 @@ module GitHack
 			execute_success
 			self
 		end
-		def ready_to_execute
-			@is_success = false
-		end
-		def execute_success
-			@is_success = true
-		end
-		def success?
-			@is_success
-		end
-		def add_workingdirectory
-			git.add(@workingdirectory)	
-		end
-		def commit(msg)
-			msg ||= auto_commit_msg 
-			begin
-				git.commit(msg,:add_all=>true)	
-			rescue Git::GitExecuteError => e
-				puts e.to_s.colorize(:green)
-			end
-		end
-		def auto_commit_msg
-			"auto commit" # TODO: 需要完成
-		end
+
 		# undo 回到上一次提交
 		def undo
-			git_goto(1)
+			goto(1)
 		end
 		# redo 到当前提交的下一个提交
 		def redo
 			ready_to_execute
 			return self if not_git_directory?
-			next_commit = get_next_commit
+			next_commit = commit_facade.get_next_commit
 			return self if !next_commit
 			git.reset_hard(next_commit)
 			execute_success
 			self
 		end
-		def git_goto(number,options={})
-			number = number.to_i
-			goto(number,options)
-			
-		end
 		# 回到前第number个保存
 		#
 		def goto(number,options={})
 			ready_to_execute
 			return self if not_git_directory?
-			git.reset_hard(commits[number].commit['sha'])
+			ap commits
+			git.reset_hard(commits[number].sha)
 			execute_success
 			self
 		end
+		# 初始化空文件夹成为git库
 		def init(dir)
 			@git = Git.init(dir)
 			@workingdirectory = dir
 		end
+		def show_commits
+			ap commits
+		end
+		#
+		# 得到本身或是上层目录中.git文件的路经
+		#
+		def get_gitdir(path)
+			git_path = absolute_path(path)
+			return nil if git_path == "/"
+			return git_path if is_gitdir?(git_path) 
+			return get_gitdir(join(git_path,"/../"))
+		end
+
+		private
 		def not_git_directory?
 			if @workingdirectory == nil
 				puts "Not a git directory ,run `git init` first"
@@ -109,33 +104,23 @@ module GitHack
 			end
 			return false
 		end
-		def get_next_commit 
-			file = File.open("#{@workingdirectory}/.git/logs/HEAD")
-			data = []
-			file.each { |line|
-				data << line
-			}
-			commit_data = SimpleLineBuilder.new(data,0).find_all
-			commit = commit_data.find do |c| 
-				c.object == current_commit 
+		def is_gitdir?(path)
+			File.directory?(join(path,".git")) ? true : false
+		end
+		
+		def add_workingdirectory
+			git.add(@workingdirectory)	
+		end
+		def commit(msg)
+			msg ||= auto_commit_msg 
+			begin
+				git.commit(msg,:add_all=>true)	
+			rescue Git::GitExecuteError => e
+				puts e.to_s.colorize(:green)
 			end
-			commit_sha = commit ?  commit.value : nil
-		end
-		def current_commit
-			@current_commit if @current_commit
-			data = data_from_file("#{@workingdirectory}/.git/HEAD")
-			commit_file_data = SimpleLineBuilder.new(data,0).parse
-			commit_file = commit_file_data.value
-			@current_commit = data_from_file("#{@workingdirectory}/.git/#{commit_file}")
-			@current_commit = @current_commit[0].chomp
-		end
-		def data_from_file(path)
-			file = File.open(path)
-			data = []
-			file.each { |line|
-				data << line
-			}
-			data 
+		end
+		def auto_commit_msg
+			"auto commit" # TODO: 需要完成
 		end
 	end
 end

data/lib/git-hack/simple_line_builder.rb

@@ -8,8 +8,7 @@ module GitHack
 			super(data,index)
 		end
 		def process_line
-			line = @data[@index]
-			line = line.chomp.split
+			line = @data[@index].chomp.split
 			@object = line.shift
 			@value = line.shift
 		end

data/lib/git-hack/version.rb

@@ -1,3 +1,3 @@
 module GitHack
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
 end

data/spec/commit_facade_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe CommitFacade do
+	before do
+		@dir = dir_under_git
+		refresh_dir(@dir)
+		Git.init(@dir) 
+		@gitrepo = GitRepo.new(@dir)
+		@gitrepo.get_gitdir(@dir)
+		@msg = "test commit "
+		add_for_commit("#{@dir}/test")
+		@gitrepo.git_save(@msg)
+		add_for_commit("#{@dir}/test2")
+		@gitrepo.git_save(@msg)
+		@cf = CommitFacade.new(@dir)
+	end
+	describe "# get_log_commits " do
+		context "When given dir " do
+			it "Should return commits frome log. " do
+				@cf.get_log_commits.length.should be 2
+			end
+			it "Show data" do
+				#ap @cf.get_log_commits
+				#ap @cf.get_log_commits[0]
+			end
+			
+		end
+		
+	end
+	after { del_dir(@dir) }
+end

data/spec/git_repo_spec.rb

@@ -5,11 +5,6 @@ require "spec_helper"
 
 
 describe GitRepo do
-	# test data
-	let(:dir_with_git) { project_dir }
-	let(:dir_under_git) { join(project_dir,"tmp_git_hack_test") }
-	let(:dir_no_git) { "#{ENV["HOME"]}/tmp_git_hack_test" }
-
 	describe	"#get_gitdir " do
 		context "When given a .git directory" do
 			specify { GitRepo.new(dir_with_git).get_gitdir(dir_with_git).should == dir_with_git }

data/spec/line_builder_spec.rb

@@ -12,14 +12,16 @@ describe LineBuilder do
 	end
 	specify { @data.size.should be > 1 }
 	specify { @linebuilder.object.should_not be nil }
+	specify { @linebuilder.all_objects.size.should be > 0 }
 	specify { @linebuilder.is_over?.should_not be true }
 	specify { @linebuilder.get_next.should_not be nil }
 	specify { @linebuilder.rest.size.should be > 0 }
 	specify { @linebuilder.find_all.size.should be > 0 }
+	specify { @linebuilder.data.should be @linebuilder.get_next.data }
+	# 用于查看内部数据的查看spec
 	it "Show Some data" do
 		puts @linebuilder.index
 		puts @data.size
-		
 	end
 	context "When is come to the last" do
 		before do

data/spec/spec_helper.rb

@@ -1,7 +1,9 @@
 require_relative "../lib/git-hack"
+require_relative "test_env"
 
 include GitHack
 include PathCommon
+include TestENV
 require "fileutils"
 require "colorize"
 

data/spec/test_env.rb

@@ -0,0 +1,15 @@
+# 为测试准备环境用的一些方法
+module TestENV
+	def dir_with_git
+		project_dir
+	end
+	def dir_under_git
+		join(project_dir,"tmp_git_hack_test")
+	end
+	def dir_no_git
+		"#{ENV["HOME"]}/tmp_git_hack_test" 
+	end
+end
+
+	
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-hack
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
-  requirement: &22140160 !ruby/object:Gem::Requirement
+  requirement: &10189420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22140160
+  version_requirements: *10189420
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &22139340 !ruby/object:Gem::Requirement
+  requirement: &10188960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,12 +32,13 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *22139340
+  version_requirements: *10188960
 description: A more smart tools of git. Come from git-smart
 email:
 - azhao.1981@gmail.com
 executables:
 - git-goto
+- git-minilog
 - git-redo
 - git-save
 - git-undo
@@ -50,6 +51,7 @@ files:
 - README.md
 - Rakefile
 - bin/git-goto
+- bin/git-minilog
 - bin/git-redo
 - bin/git-save
 - bin/git-undo
@@ -58,16 +60,20 @@ files:
 - lib/core_ext/git_patch.rb
 - lib/core_ext/line_builder.rb
 - lib/core_ext/path.rb
+- lib/core_ext/save_execute.rb
 - lib/git-hack.rb
 - lib/git-hack/commit.rb
+- lib/git-hack/commit_facade.rb
 - lib/git-hack/commit_line_builder.rb
 - lib/git-hack/git_repo.rb
 - lib/git-hack/simple_line_builder.rb
 - lib/git-hack/version.rb
+- spec/commit_facade_spec.rb
 - spec/commit_line_builder_spec.rb
 - spec/git_repo_spec.rb
 - spec/line_builder_spec.rb
 - spec/spec_helper.rb
+- spec/test_env.rb
 - spec/tmp/hello_for_rspec
 - tmp/classtest.rb
 - tmp/cli.rb