capillary 0.2.4 → 0.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    capillary (0.2.3)
+    capillary (0.3.0)
       json (~> 1.5.1)
 
 GEM

data/README

@@ -18,7 +18,13 @@ Capillary.rb emits a JSON array consisting of JSON objects in the
 following form (starting with seqId=0):
 
 	[[{
-            "refNames": ["HEAD", "origin/production", "production"],
+            "refs": {
+                "remotes": {
+                    "origin": { "production" }
+                },
+                "heads": ["production", "master"],
+                "tags": ["v2.0.0"]
+            },
             "seqId": 0,
             "committedAt": "Fri Jul 15 07:23:44 +0200 2011",
             "parentIds": ["8f38426b1641a20511f6eeb6878f2e1e00712df2", "ce7de03fc2cb6114d2f859fefc996e7fffa2d7f6"],
@@ -26,7 +32,7 @@ following form (starting with seqId=0):
             "committerEmail": "christian@gitorious.org",
             "message": "Merge branch 'master' into production"
         }, {
-            "refNames": [],
+            "refs": { "heads": [], "tags": [], "remotes": {} },
             "seqId": 1,
             "committedAt": "Thu Jun 16 10:20:03 +0200 2011",
             "parentIds": ["0443fcdf66df410993441b617d14dab121245ff7"],
@@ -43,8 +49,8 @@ following form (starting with seqId=0):
 * id: The commit sha
 * parentIds: The commit sha of all parent commits of this commit
 * message: The commit message
-* Ref names: Relevant names of branches that concern the commit
-  in question
+* refs: Relevant names of heads, tags, remotes and others that concern the
+  commit in question
 
 Note that the JSON emitted is a nested array - an array of "paths", where each
 path is an array of commits.
@@ -138,14 +144,19 @@ Capillary parses output from Git log, in the format as specified in
 test/fixtures/single_commit.txt. This output was generated from Git using the
 following command:
 
-    git log --pretty=format:"%H§%P§%ad§%ae§%d§%s§"
+    git log --pretty=format:"%H§%P§%ad§%ae§%d§%s§" --decorate=full
 
-You may also use the following command, which orders commits slightly
-differently, and is perhaps more suitable for graph generation. Note that this
-command outputs an extra line per commit, which may be an issue if I/O is a
-concern:
+This will produce a graph where commits are strictly ordered by date. To get a
+graph similar to that produced by `git log --graph`, you add - surprise - the
+`--graph` option:
 
-    git rev-list --pretty=format:"%H§%P§%ad§%ae§%d§%s§" --topo-order -50 master
+    git log --pretty=format:"%H§%P§%ad§%ae§%d§%s§" --decorate=full --graph
+
+Both of these will produce a graph that includes all ancestors to the current
+HEAD. If you want everything - including branches not merged to the current
+branch, use `--all`:
+
+    git log --pretty=format:"%H§%P§%ad§%ae§%d§%s§" --decorate=full --graph --all
 
 The name
 --------

data/bin/capillary

@@ -1,6 +1,21 @@
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
 require "capillary/log_parser"
 
 parser = Capillary::LogParser.new
-$stdin.each { |line| parser << line }
-puts parser.to_json
+
+if ARGV == ["-v"] || ARGV == ["--version"]
+  require "capillary/version"
+  puts "Capillary #{Capillary::VERSION}"
+elsif ARGV == ["-h"] || ARGV == ["--help"]
+  puts "Convert git log on STDIN to JSON suitable for further processing by capillary.js"
+  puts ""
+  puts "Generate suitable log output from Git like this: (where --all is optional)"
+  puts "git log --pretty=format:\"%H§%P§%ad§%ae§%d§%s§\" --decorate=full --graph --all"
+  puts ""
+  puts "Generate ASCII graph if you have installed capillary.js:"
+  puts "git log --pretty=format:\"%H§%P§%ad§%ae§%d§%s§\" --decorate=full --graph --all | capillary | capillary-js"
+else
+  $stdin.each { |line| parser << line }
+  puts parser.to_json
+end

data/lib/capillary/commit.rb

@@ -15,14 +15,20 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
+require "json"
 require "time"
+require "capillary/ref_collection"
 
 module Capillary
   class Commit
     attr_accessor :id, :parent_ids, :committed_at, :message, :committer_email, :seq_id
-    attr_reader :ref_names
+    attr_reader :refs
     LOG_SEPARATOR = "§"
 
+    def initialize
+      @refs = RefCollection.new
+    end
+
     # Creates an instance from Git output
     def self.parse(git_line)
       git_line = git_line.gsub(/^[^a-f0-9]+/, "")
@@ -34,25 +40,17 @@ module Capillary
       result.parent_ids = parts[1].split(" ")
       result.committed_at = Time.parse(parts[2])
       result.committer_email = parts[3]
-      result.ref_names = parts[4]
+      result.refs.parse(parts[4])
       result.message = parts[5]
       result
     end
 
-    def ref_names=(spec)
-      if spec == ""
-        @ref_names = []
-      else
-        @ref_names = spec.gsub(/[\(\)]/,"").split(/,\s?/).collect(&:strip)
-      end
-    end
-
     def to_hash
       { "id" => id,
         "parent_ids" => parent_ids,
         "committed_at" => committed_at,
         "committer_email" => committer_email,
-        "ref_names" => ref_names,
+        "refs" => refs.to_hash,
         "message" => message }
     end
 
@@ -61,7 +59,7 @@ module Capillary
                      "parentIds" => parent_ids,
                      "committedAt" => committed_at,
                      "committerEmail" => committer_email,
-                     "refNames" => ref_names,
+                     "refs" => refs.to_hash,
                      "message" => message,
                      "seqId" => seq_id})
     end

data/lib/capillary/ref_collection.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+#--
+#   Copyright (C) 2011 Gitorious AS
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+require "json"
+
+module Capillary
+  class RefCollection
+    def initialize
+      @refs = {
+        "heads" => [],
+        "tags" => [],
+        "remotes" => {}
+      }
+    end
+
+    def self.parse(ref)
+      refs = new
+      refs.parse(ref)
+      refs
+    end
+
+    def parse(ref)
+      return if ref.nil? || ref == ""
+      ref.gsub(/[\(\)]/,"").split(/,\s?/).each { |r| self << r }
+    end
+
+    def <<(full_ref)
+      refs, type, *name = full_ref.strip.split("/")
+      return if type.nil?
+      type = type.gsub("-", "_")
+
+      if type == "remotes"
+        append_array_in_hash(@refs[type], name.shift, name)
+      else
+        append_array_in_hash(@refs, type, name)
+      end
+    end
+
+    def to_hash
+      @refs.dup
+    end
+
+    def to_json
+      JSON.unparse(@refs)
+    end
+
+    def method_missing(method, *args, &block)
+      key = method.to_s
+      return super if !@refs.key?(key) || args.length != 0
+      @refs[key]
+    end
+
+    private
+    def append_array_in_hash(hash, key, names)
+      hash[key] ||= []
+      hash[key] << names.join("/")
+    end
+  end
+end

data/lib/capillary/version.rb

@@ -17,5 +17,5 @@
 #++
 
 module Capillary
-  VERSION = "0.2.4"
+  VERSION = "0.3.0"
 end

data/test/capillary/commit_test.rb

@@ -15,7 +15,6 @@
 #   You should have received a copy of the GNU Affero General Public License
 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #++
-
 require "json"
 require "test_helper"
 require "capillary/commit"
@@ -47,13 +46,12 @@ class CommitTest < MiniTest::Spec
       assert_equal "And this is commit 10 Merge branch 'topic'", @commit.message
     end
 
-    should "include specified ref names" do
-      assert_equal(["master","refactor"], @commit.ref_names)
+    should "include specified heads" do
+      assert_equal(["master","refactor"], @commit.refs.heads)
     end
 
-    should "not include non-specified ref names" do
-      @commit.ref_names = ""
-      assert_equal [], @commit.ref_names
+    should "include specified tags" do
+      assert_equal(["v2.0.0"], @commit.refs.tags)
     end
 
     should "convert commit to JSON" do
@@ -62,7 +60,7 @@ class CommitTest < MiniTest::Spec
         "parentIds" => ["db75ad82d678d51b29709d26af64d4a85b6f8071"],
         "committedAt" => "Wed Jul 13 07:55:47 +0200 2011",
         "committerEmail" => "chris@example.com",
-        "refNames" => ["master", "refactor"],
+        "refs" => { "heads" => ["master", "refactor"], "tags" => ["v2.0.0"], "remotes" => {} },
         "message" => "And this is commit 10 Merge branch 'topic'",
         "seqId" => nil
       }

data/test/capillary/log_parser_test.rb

@@ -26,20 +26,17 @@ class LogParserTest < MiniTest::Spec
     branches[num].collect { |c| c.id[0...7] }
   end
 
-  def load_fixture(fixture, num = -1)
-    parse_log(fixture(fixture), num)
+  def load_fixture(fixture)
+    parse_log(fixture(fixture))
   end
 
-  def parse_log(log, num = -1)
+  def parse_log(log)
     @log_parser = Capillary::LogParser.new
     @lines = []
-    i = 0
 
     log.split("\n").reject { |f| f.strip == "" }.each do |log|
-      return if num >= 0 && i == num
       @lines << Capillary::Commit.parse(log)
       @log_parser << @lines.last
-      i += 1
     end
   end
 
@@ -637,34 +634,6 @@ c4e7446e2a98f1bf28da51fc57bb42b532222942§c3e1d675667939e64ced1bb5b541c9042a1d60
     end
   end
 
-  # 8ff4eb2
-  # |
-  # db060ee
-  # |      \
-  # |       0bca89d
-  # |       |
-  # |       1793145
-  # |       |
-  # |       f9e1735
-  # |       |
-  # 4aee02f |
-  # |       |
-  # |       07b25c9
-  # |       |
-  context "Axis log" do
-    setup do
-      load_fixture("axis.txt", 50)
-    end
-
-    should "include correct commits in second branch" do
-      assert_equal %w[db060ee 0bca89d 1793145 f9e1735], commits_for_branch(1)
-    end
-
-    should "include correct commits in fifth branch" do
-      assert_equal %w[e2f706e 02edff1 3e54c31], commits_for_branch(5)
-    end
-  end
-
   context "Streaming parser" do
     setup do
       @lines = fixture("complex_graph_no_ff.txt").split("\n")

data/test/capillary/ref_collection_test.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+#--
+#   Copyright (C) 2011 Gitorious AS
+#
+#   This program is free software: you can redistribute it and/or modify
+#   it under the terms of the GNU Affero General Public License as published by
+#   the Free Software Foundation, either version 3 of the License, or
+#   (at your option) any later version.
+#
+#   This program is distributed in the hope that it will be useful,
+#   but WITHOUT ANY WARRANTY; without even the implied warranty of
+#   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#   GNU Affero General Public License for more details.
+#
+#   You should have received a copy of the GNU Affero General Public License
+#   along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require "test_helper"
+require "capillary/ref_collection"
+
+class RefCollectionTest < MiniTest::Spec
+  context "Parsing refs" do
+    should "ignore HEAD" do
+      refs = Capillary::RefCollection.parse("HEAD")
+
+      refute refs.to_hash.key?(nil)
+      assert_equal [], refs.heads
+      assert_equal [], refs.tags
+    end
+
+    should "find heads" do
+      refs = Capillary::RefCollection.parse("(HEAD, refs/heads/master)")
+
+      assert_equal ["master"], refs.heads
+    end
+
+    should "find tags" do
+      refs = Capillary::RefCollection.parse("(HEAD, refs/heads/master, refs/tags/v2.0.0)")
+
+      assert_equal ["v2.0.0"], refs.tags
+    end
+
+    should "find remotes" do
+      refs = Capillary::RefCollection.parse("(HEAD, refs/heads/master, refs/tags/v2.0.0, refs/remotes/origin/branch)")
+
+      assert_equal({ "origin" => ["branch"] }, refs.remotes)
+    end
+
+    should "find merge requests" do
+      refs = Capillary::RefCollection.parse("(HEAD, refs/merge-requests/1304)")
+
+      assert_equal ["1304"], refs.merge_requests
+    end
+  end
+end

data/test/fixtures/first_commit.txt

@@ -1 +1 @@
-a7cf78bfff06d52b5b0aa021508b44c00cad067a§db75ad82d678d51b29709d26af64d4a85b6f8071§2011-07-13 07:55:47 +0200§chris@example.com§ (master, refactor)§And this is commit 10 Merge branch 'topic'§
+a7cf78bfff06d52b5b0aa021508b44c00cad067a§db75ad82d678d51b29709d26af64d4a85b6f8071§2011-07-13 07:55:47 +0200§chris@example.com§ (refs/heads/master, refs/heads/refactor, refs/tags/v2.0.0)§And this is commit 10 Merge branch 'topic'§

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: capillary
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marius Mathiesen
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-30 00:00:00 +02:00
+date: 2011-08-31 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -86,9 +86,11 @@ files:
 - lib/capillary.rb
 - lib/capillary/commit.rb
 - lib/capillary/log_parser.rb
+- lib/capillary/ref_collection.rb
 - lib/capillary/version.rb
 - test/capillary/commit_test.rb
 - test/capillary/log_parser_test.rb
+- test/capillary/ref_collection_test.rb
 - test/fixtures/4x_dangling_branches.txt
 - test/fixtures/complex_graph.txt
 - test/fixtures/complex_graph_no_ff.txt