mojombo-grit 0.9.4 → 1.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. data/API.txt +101 -0
  2. data/History.txt +38 -2
  3. data/README.md +210 -0
  4. data/VERSION.yml +4 -0
  5. data/lib/grit.rb +13 -4
  6. data/lib/grit/blame.rb +61 -0
  7. data/lib/grit/blob.rb +11 -2
  8. data/lib/grit/commit.rb +44 -31
  9. data/lib/grit/commit_stats.rb +26 -2
  10. data/lib/grit/diff.rb +6 -6
  11. data/lib/grit/git-ruby.rb +4 -2
  12. data/lib/grit/git-ruby/file_index.rb +10 -3
  13. data/lib/grit/git-ruby/git_object.rb +9 -3
  14. data/lib/grit/git-ruby/internal/{mmap.rb → file_window.rb} +2 -2
  15. data/lib/grit/git-ruby/internal/loose.rb +6 -6
  16. data/lib/grit/git-ruby/internal/pack.rb +19 -19
  17. data/lib/grit/git-ruby/object.rb +8 -2
  18. data/lib/grit/git-ruby/repository.rb +11 -6
  19. data/lib/grit/git.rb +23 -10
  20. data/lib/grit/index.rb +12 -11
  21. data/lib/grit/merge.rb +45 -0
  22. data/lib/grit/ref.rb +20 -16
  23. data/lib/grit/repo.rb +59 -9
  24. data/lib/grit/ruby1.9.rb +7 -0
  25. data/lib/grit/submodule.rb +5 -1
  26. data/lib/grit/tag.rb +61 -66
  27. data/lib/grit/tree.rb +20 -1
  28. metadata +29 -47
  29. data/Manifest.txt +0 -71
  30. data/README.txt +0 -213
  31. data/Rakefile +0 -29
  32. data/grit.gemspec +0 -62
  33. data/lib/grit/head.rb +0 -83
  34. data/test/test_actor.rb +0 -35
  35. data/test/test_blob.rb +0 -79
  36. data/test/test_commit.rb +0 -190
  37. data/test/test_config.rb +0 -58
  38. data/test/test_diff.rb +0 -18
  39. data/test/test_git.rb +0 -64
  40. data/test/test_grit.rb +0 -32
  41. data/test/test_head.rb +0 -47
  42. data/test/test_real.rb +0 -19
  43. data/test/test_reality.rb +0 -17
  44. data/test/test_remote.rb +0 -14
  45. data/test/test_repo.rb +0 -277
  46. data/test/test_tag.rb +0 -25
  47. data/test/test_tree.rb +0 -96
data/API.txt ADDED
@@ -0,0 +1,101 @@
1
+ == TODO ==
2
+
3
+ * Add remote branch references (Grit::Remote)
4
+ * Add status - what is modified, staged
5
+
6
+ g.checkout('new_branch')
7
+ g.checkout(g.branch('new_branch'))
8
+
9
+ g.branch(name).merge(branch2)
10
+ g.branch(branch2).merge # merges HEAD with branch2
11
+
12
+ g.branch(name).in_branch(message) { # add files } # auto-commits
13
+ g.merge('new_branch')
14
+ g.merge('origin/remote_branch')
15
+ g.merge(b.branch('master'))
16
+ g.merge([branch1, branch2])
17
+
18
+ r = g.add_remote(name, uri) # Git::Remote
19
+ r = g.add_remote(name, Git::Base) # Git::Remote
20
+
21
+ g.remotes # array of Git::Remotes
22
+ g.remote(name).fetch
23
+ g.remote(name).remove
24
+ g.remote(name).merge
25
+ g.remote(name).merge(branch)
26
+
27
+ g.fetch
28
+ g.fetch(g.remotes.first)
29
+
30
+ g.pull
31
+ g.pull(Git::Repo, Git::Branch) # fetch and a merge
32
+
33
+ g.add_tag('tag_name') # returns Git::Tag
34
+
35
+ g.repack
36
+
37
+ g.push
38
+ g.push(g.remote('name'))
39
+
40
+ g.reset # defaults to HEAD
41
+ g.reset_hard(Git::Commit)
42
+
43
+ g.branch('new_branch') # creates new or fetches existing
44
+ g.branch('new_branch').checkout
45
+ g.branch('new_branch').delete
46
+ g.branch('existing_branch').checkout
47
+
48
+
49
+
50
+
51
+
52
+ require 'mojombo-grit'
53
+
54
+ include Grit
55
+ Grit.debug
56
+ Grit.use_pure_ruby
57
+
58
+ repo = Repo.new("/Users/tom/dev/grit")
59
+
60
+ = Commit Log
61
+
62
+ repo.commits('mybranch')
63
+ repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe')
64
+ repo.commits('v0.1')
65
+
66
+ repo.log('mybranch', 100, 20)
67
+
68
+ head = repo.commits.first
69
+ head.id
70
+ # => "e80bbd2ce67651aa18e57fb0b43618ad4baf7750"
71
+ head.parents
72
+ # => [#<Grit::Commit "91169e1f5fa4de2eaea3f176461f5dc784796769">]
73
+ head.tree
74
+ # => #<Grit::Tree "3536eb9abac69c3e4db583ad38f3d30f8db4771f">
75
+ head.author
76
+ # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
77
+ head.authored_date
78
+ # => Wed Oct 24 22:02:31 -0700 2007
79
+ head.committer
80
+ # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
81
+ head.committed_date
82
+ # => Wed Oct 24 22:02:31 -0700 2007
83
+ head.message
84
+ # => "add Actor inspect"
85
+ contents = tree.contents
86
+ # => [#<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">,
87
+ #<Grit::Blob "81d2c27608b352814cbe979a6acd678d30219678">,
88
+ #<Grit::Tree "c3d07b0083f01a6e1ac969a0f32b8d06f20c62e5">,
89
+ #<Grit::Tree "4d00fe177a8407dbbc64a24dbfc564762c0922d8">]
90
+ blob.id
91
+ # => "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666"
92
+ blob.name
93
+ # => "README.txt"
94
+ blob.mode
95
+ # => "100644"
96
+ blob.size
97
+ # => 7726
98
+ blob.data
99
+
100
+ repo.blob("4ebc8aea50e0a67e000ba29a30809d0a7b9b2666")
101
+ # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
@@ -1,3 +1,41 @@
1
+ == 1.1.0 / 2009-03-29
2
+ * Backwards breaking changes
3
+ * Diff#a_commit -> Diff#a_blob, Diff#b_commit -> Diff#b_blob
4
+ * Major Enhancments
5
+ * Ruby 1.9 compatibility [github.com/chapados, github.com/js]
6
+ * Minor Enhancements
7
+ * Convert readme to markdown
8
+ * Added a shortcut for commit_stats as Commit#stats [github.com/js]
9
+ * Add a #basename method to Submodule, Blob and Tree for retrieving the name [github.com/js]
10
+ * Make Grit::Submodule grasp the concept of non-unix lineendings [github.com/js]
11
+ * Added Repo#commit_deltas_from [github.com/js]
12
+ * do some mild shell escaping when running commands [github.com/js]
13
+ * Added two shortcut methods to Tree, for picking trees/blobs only [github.com/Voker57]
14
+ * Added <=> method to Blob, needed for sorting tree [github.com/Voker57]
15
+ * Make the number of bytes to be read from git's stdout configurable [github.com/josb]
16
+ * Repo.archive_to_file accepts extra parameters making plain zipping possible [github.com/darwin]
17
+ * Handle commit stats that summarize commits with binary changes [github.com/therealadam]
18
+ * Add a DiffStat class for easy access to diff stats [github.com/therealadam]
19
+ * Don't split git logs that contain blank lines into two CommitStats [github.com/therealadam]
20
+ * Add DiffStat#net for total change count [github.com/therealadam]
21
+
22
+ == 1.0.3 / 2009-02-13
23
+ * Minor Enhancements
24
+ * Added Grit::Commit#to_patch for plaintext formatted patches.
25
+ * Fixed Grit::Tag to work with annotated tags.
26
+
27
+ == 1.0.2 / 2009-02-10
28
+ * Minor Enhancements
29
+ * Implement Grit.version to use VERSION.yml file
30
+
31
+ == 1.0.1 / 2009-02-10
32
+ * Bug Fixes
33
+ * Add diff-lcs as a dependency
34
+
35
+ == 1.0.0 / 2009-01-27
36
+ * Tons of awesome in here. Also, we suck at updating the history.
37
+ * Let's do better at that from now on.
38
+
1
39
  == 0.8.3 / 2008-07-07
2
40
  * Capture stderr and log if debug is true (rsanheim)
3
41
 
@@ -9,5 +47,3 @@
9
47
 
10
48
  == 0.7.0 / 2008-01-07
11
49
  * First public release!
12
-
13
-
@@ -0,0 +1,210 @@
1
+ Grit
2
+ ====
3
+
4
+ Grit gives you object oriented read/write access to Git repositories via Ruby.
5
+ The main goals are stability and performance. To this end, some of the
6
+ interactions with Git repositories are done by shelling out to the system's
7
+ `git` command, and other interactions are done with pure Ruby
8
+ reimplementations of core Git functionality. This choice, however, is
9
+ transparent to end users, and you need not know which method is being used.
10
+
11
+ This software was developed to power GitHub, and should be considered
12
+ production ready. An extensive test suite is provided to verify its correctness.
13
+
14
+ Grit is maintained by Tom Preston-Werner, Scott Chacon, Chris Wanstrath, and
15
+ PJ Hyett.
16
+
17
+ This documentation is accurate as of Grit 1.0.2.
18
+
19
+
20
+ ## Requirements #############################################################
21
+
22
+ * git (http://git-scm.com) tested with 1.6.0.2
23
+
24
+
25
+ ## Install ##################################################################
26
+
27
+ Easiest install is via RubyGems:
28
+
29
+ $ gem install grit
30
+
31
+ or
32
+
33
+ $ gem sources -a http://gems.github.com/ (you only need to do this once)
34
+ $ gem install mojombo-grit
35
+
36
+ The gem from GitHub will generally be available sooner than the gem from
37
+ Rubyforge. Both sources will eventually contain the same releases.
38
+
39
+
40
+ ## Source ###################################################################
41
+
42
+ Grit's Git repo is available on GitHub, which can be browsed at:
43
+
44
+ http://github.com/mojombo/grit
45
+
46
+ and cloned with:
47
+
48
+ git clone git://github.com/mojombo/grit.git
49
+
50
+
51
+ ## Usage ####################################################################
52
+
53
+ Grit gives you object model access to your Git repositories. Once you have
54
+ created a `Repo` object, you can traverse it to find parent commits,
55
+ trees, blobs, etc.
56
+
57
+ ### Initialize a Repo object
58
+
59
+ The first step is to create a `Grit::Repo` object to represent your repo. In
60
+ this documentation I include the `Grit` module to reduce typing.
61
+
62
+ require 'grit'
63
+ include Grit
64
+ repo = Repo.new("/Users/tom/dev/grit")
65
+
66
+ In the above example, the directory `/Users/tom/dev/grit` is my working
67
+ directory and contains the `.git` directory. You can also initialize Grit with
68
+ a bare repo.
69
+
70
+ repo = Repo.new("/var/git/grit.git")
71
+
72
+ ### Getting a list of commits
73
+
74
+ From the `Repo` object, you can get a list of commits as an array of `Commit`
75
+ objects.
76
+
77
+ repo.commits
78
+ # => [#<Grit::Commit "e80bbd2ce67651aa18e57fb0b43618ad4baf7750">,
79
+ #<Grit::Commit "91169e1f5fa4de2eaea3f176461f5dc784796769">,
80
+ #<Grit::Commit "038af8c329ef7c1bae4568b98bd5c58510465493">,
81
+ #<Grit::Commit "40d3057d09a7a4d61059bca9dca5ae698de58cbe">,
82
+ #<Grit::Commit "4ea50f4754937bf19461af58ce3b3d24c77311d9">]
83
+
84
+ Called without arguments, `Repo#commits` returns a list of up to ten commits
85
+ reachable by the **master** branch (starting at the latest commit). You can
86
+ ask for commits beginning at a different branch, commit, tag, etc.
87
+
88
+ repo.commits('mybranch')
89
+ repo.commits('40d3057d09a7a4d61059bca9dca5ae698de58cbe')
90
+ repo.commits('v0.1')
91
+
92
+ You can specify the maximum number of commits to return.
93
+
94
+ repo.commits('master', 100)
95
+
96
+ If you need paging, you can specify a number of commits to skip.
97
+
98
+ repo.commits('master', 10, 20)
99
+
100
+ The above will return commits 21-30 from the commit list.
101
+
102
+ ### The Commit object
103
+
104
+ `Commit` objects contain information about that commit.
105
+
106
+ head = repo.commits.first
107
+
108
+ head.id
109
+ # => "e80bbd2ce67651aa18e57fb0b43618ad4baf7750"
110
+
111
+ head.parents
112
+ # => [#<Grit::Commit "91169e1f5fa4de2eaea3f176461f5dc784796769">]
113
+
114
+ head.tree
115
+ # => #<Grit::Tree "3536eb9abac69c3e4db583ad38f3d30f8db4771f">
116
+
117
+ head.author
118
+ # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
119
+
120
+ head.authored_date
121
+ # => Wed Oct 24 22:02:31 -0700 2007
122
+
123
+ head.committer
124
+ # => #<Grit::Actor "Tom Preston-Werner <tom@mojombo.com>">
125
+
126
+ head.committed_date
127
+ # => Wed Oct 24 22:02:31 -0700 2007
128
+
129
+ head.message
130
+ # => "add Actor inspect"
131
+
132
+ You can traverse a commit's ancestry by chaining calls to `#parents`.
133
+
134
+ repo.commits.first.parents[0].parents[0].parents[0]
135
+
136
+ The above corresponds to **master^^^** or **master~3** in Git parlance.
137
+
138
+ ### The Tree object
139
+
140
+ A tree records pointers to the contents of a directory. Let's say you want
141
+ the root tree of the latest commit on the **master** branch.
142
+
143
+ tree = repo.commits.first.tree
144
+ # => #<Grit::Tree "3536eb9abac69c3e4db583ad38f3d30f8db4771f">
145
+
146
+ tree.id
147
+ # => "3536eb9abac69c3e4db583ad38f3d30f8db4771f"
148
+
149
+ Once you have a tree, you can get the contents.
150
+
151
+ contents = tree.contents
152
+ # => [#<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">,
153
+ #<Grit::Blob "81d2c27608b352814cbe979a6acd678d30219678">,
154
+ #<Grit::Tree "c3d07b0083f01a6e1ac969a0f32b8d06f20c62e5">,
155
+ #<Grit::Tree "4d00fe177a8407dbbc64a24dbfc564762c0922d8">]
156
+
157
+ This tree contains two `Blob` objects and two `Tree` objects. The trees are
158
+ subdirectories and the blobs are files. Trees below the root have additional
159
+ attributes.
160
+
161
+ contents.last.name
162
+ # => "lib"
163
+
164
+ contents.last.mode
165
+ # => "040000"
166
+
167
+ There is a convenience method that allows you to get a named sub-object
168
+ from a tree.
169
+
170
+ tree / "lib"
171
+ # => #<Grit::Tree "e74893a3d8a25cbb1367cf241cc741bfd503c4b2">
172
+
173
+ You can also get a tree directly from the repo if you know its name.
174
+
175
+ repo.tree
176
+ # => #<Grit::Tree "master">
177
+
178
+ repo.tree("91169e1f5fa4de2eaea3f176461f5dc784796769")
179
+ # => #<Grit::Tree "91169e1f5fa4de2eaea3f176461f5dc784796769">
180
+
181
+ ### The Blob object
182
+
183
+ A blob represents a file. Trees often contain blobs.
184
+
185
+ blob = tree.contents.first
186
+ # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
187
+
188
+ A blob has certain attributes.
189
+
190
+ blob.id
191
+ # => "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666"
192
+
193
+ blob.name
194
+ # => "README.txt"
195
+
196
+ blob.mode
197
+ # => "100644"
198
+
199
+ blob.size
200
+ # => 7726
201
+
202
+ You can get the data of a blob as a string.
203
+
204
+ blob.data
205
+ # => "Grit is a library to ..."
206
+
207
+ You can also get a blob directly from the repo if you know its name.
208
+
209
+ repo.blob("4ebc8aea50e0a67e000ba29a30809d0a7b9b2666")
210
+ # => #<Grit::Blob "4ebc8aea50e0a67e000ba29a30809d0a7b9b2666">
@@ -0,0 +1,4 @@
1
+ ---
2
+ :major: 1
3
+ :minor: 1
4
+ :patch: 1
@@ -17,14 +17,19 @@ end
17
17
 
18
18
  # third party
19
19
  require 'rubygems'
20
+ gem "mime-types", ">=0"
20
21
  require 'mime/types'
21
22
 
23
+ # ruby 1.9 compatibility
24
+ require 'grit/ruby1.9'
25
+
22
26
  # internal requires
23
27
  require 'grit/lazy'
24
28
  require 'grit/errors'
25
29
  require 'grit/git-ruby'
26
30
  require 'grit/git'
27
31
  require 'grit/ref'
32
+ require 'grit/tag'
28
33
  require 'grit/commit'
29
34
  require 'grit/commit_stats'
30
35
  require 'grit/tree'
@@ -36,10 +41,11 @@ require 'grit/repo'
36
41
  require 'grit/index'
37
42
  require 'grit/status'
38
43
  require 'grit/submodule'
44
+ require 'grit/blame'
45
+ require 'grit/merge'
39
46
 
40
47
 
41
48
  module Grit
42
-
43
49
  class << self
44
50
  # Set +debug+ to true to log all git calls and responses
45
51
  attr_accessor :debug
@@ -52,8 +58,11 @@ module Grit
52
58
  end
53
59
  self.debug = false
54
60
  self.use_git_ruby = true
55
-
61
+
56
62
  @logger ||= ::Logger.new(STDOUT)
57
-
58
- VERSION = '0.9.4'
63
+
64
+ def self.version
65
+ yml = YAML.load(File.read(File.join(File.dirname(__FILE__), *%w[.. VERSION.yml])))
66
+ "#{yml[:major]}.#{yml[:minor]}.#{yml[:patch]}"
67
+ end
59
68
  end
@@ -0,0 +1,61 @@
1
+ module Grit
2
+
3
+ class Blame
4
+
5
+ attr_reader :lines
6
+
7
+ def initialize(repo, file, commit)
8
+ @repo = repo
9
+ @file = file
10
+ @commit = commit
11
+ @lines = []
12
+ load_blame
13
+ end
14
+
15
+ def load_blame
16
+ output = @repo.git.blame({'p' => true}, @commit, '--', @file)
17
+ process_raw_blame(output)
18
+ end
19
+
20
+ def process_raw_blame(output)
21
+ lines, final = [], []
22
+ info, commits = {}, {}
23
+
24
+ # process the output
25
+ output.split("\n").each do |line|
26
+ if line[0, 1] == "\t"
27
+ lines << line[1, line.size]
28
+ elsif m = /^(\w{40}) (\d+) (\d+)/.match(line)
29
+ if !commits[m[1]]
30
+ commits[m[1]] = @repo.commit(m[1])
31
+ end
32
+ info[m[3].to_i] = [commits[m[1]], m[2].to_i]
33
+ end
34
+ end
35
+
36
+ # get it together
37
+ info.sort.each do |lineno, commit|
38
+ final << BlameLine.new(lineno, commit[1], commit[0], lines[lineno - 1])
39
+ end
40
+
41
+ @lines = final
42
+ end
43
+
44
+ # Pretty object inspection
45
+ def inspect
46
+ %Q{#<Grit::Blame "#{@file} <#{@commit}>">}
47
+ end
48
+
49
+ class BlameLine
50
+ attr_accessor :lineno, :oldlineno, :commit, :line
51
+ def initialize(lineno, oldlineno, commit, line)
52
+ @lineno = lineno
53
+ @oldlineno = oldlineno
54
+ @commit = commit
55
+ @line = line
56
+ end
57
+ end
58
+
59
+ end # Blame
60
+
61
+ end # Grit