gitoe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd353bb620692d7931c95fbb0366c0d7bbc5b97b
+  data.tar.gz: 6ca8600540cc942b042f01026d6b1dd0eef5de3e
+SHA512:
+  metadata.gz: 575750976f459a8a4ed8934673b1ce143eb85fa29559a98b37ce2a7245cb78498bca2743dd8c278f6174ad0f6db59bd4bad826a829446c9c81eaf2030be2794c
+  data.tar.gz: febe71ce3581f012e283c8b4882e84b97a4cfee96442aafec73ae81d75fb0dd9a9c6516fcad07275b52d1bf52862049df4f0ac47473535e86f352784df04f94a

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.sass-cache
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+crash.log

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/jquery.scrollTo"]
+	path = vendor/jquery.scrollTo
+	url = https://github.com/flesler/jquery.scrollTo.git

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+
+# XXX a working version over https://github.com/guard/guard-nanoc.git
+gem "guard-nanoc", :git => "https://github.com/nanoc/guard-nanoc.git"
+
+# Specify your gem's dependencies in gitoe.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,91 @@
+GIT
+  remote: https://github.com/nanoc/guard-nanoc.git
+  revision: ab6d3a3f19b73b37b1cff8e12bfae527bf63c98b
+  specs:
+    guard-nanoc (1.0.0b1)
+
+PATH
+  remote: .
+  specs:
+    gitoe (0.1.0)
+      activesupport
+      rugged
+      sinatra
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    coderay (1.0.9)
+    coffee-script (2.2.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.6.2)
+    colored (1.2)
+    cri (2.3.0)
+      colored (>= 1.2)
+    daemons (1.1.9)
+    eventmachine (1.0.3)
+    execjs (1.4.0)
+      multi_json (~> 1.0)
+    ffi (1.8.1)
+    formatador (0.2.4)
+    guard (1.8.0)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    haml (4.0.2)
+      tilt
+    i18n (0.6.1)
+    listen (1.0.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.3)
+    method_source (0.8.1)
+    multi_json (1.7.2)
+    nanoc (3.6.3)
+      cri (~> 2.3)
+    pry (0.9.12.1)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-protection (1.5.0)
+      rack
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rugged (0.16.0)
+    sass (3.2.7)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.4.4)
+    thin (1.5.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.3.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  coffee-script
+  gitoe!
+  guard
+  guard-nanoc!
+  haml
+  nanoc (>= 3.6.3)
+  pry
+  sass
+  thin

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'nanoc' do
+  watch('nanoc.yaml') # Change this to config.yaml if you use the old config file name
+  watch('Rules')
+  watch(%r{^(content)/.*$})
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Wang Guan
+
+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,30 @@
+gitoe
+=====
+#### a local web app, to show local git changes
+
+gitoe (hopefully) reveals:
+
+- what did I do ?
+- what did this `git command` do ?
+
+gitoe can be installed by:
+
+    $ gem install gitoe
+
+And running
+
+    $ gitoe
+
+starts a local web server at [127.0.0.1:12345](127.0.0.1:12345).
+
+it works by
+- dig commits out of the repo, and visualize them
+- look into `.git/logs/refs`, and parses `reflog` message.
+
+gitoe is build upon
+
+- [sinatra](www.sinatrarb.com)
+- [libgit2/rugged](https://github.com/libgit2/rugged)
+- [jquery](http://jquery.com/)
+- [Raphaël](http://raphaeljs.com/)
+

data/Rakefile

@@ -0,0 +1,35 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/test*.rb"
+end
+
+desc "gitoe (development)"
+task :run do
+  ENV["RACK_ENV"] = "development"
+  sh "bundle exec gitoe"
+end
+
+desc "gitoe (production)"
+task :production do
+  ENV["RACK_ENV"] = "production"
+  sh "bundle exec gitoe"
+end
+
+desc "watch and re-compile with guard"
+task :guard do
+  sh "bundle exec guard"
+end
+
+desc "watch and re-compile with guard"
+task :watch do
+  sh "bundle exec nanoc watch"
+end
+
+desc "compile with nanoc"
+task :compile do
+  sh "bundle exec nanoc"
+end
+
+task :default => :run

data/Rules

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+
+# A few helpful tips about the Rules file:
+#
+# * The string given to #compile and #route are matching patterns for
+#   identifiers--not for paths. Therefore, you can’t match on extension.
+#
+# * The order of rules is important: for each item, only the first matching
+#   rule is applied.
+#
+# * Item identifiers start and end with a slash (e.g. “/about/” for the file
+#   “content/about.html”). To select all children, grandchildren, … of an
+#   item, use the pattern “/about/*/”; “/about/*” will also select the parent,
+#   because “*” matches zero or more characters.
+
+compile '*' do
+  if item.binary?
+    # don’t filter binary items
+  else
+    case item[:extension]
+    when "haml"
+      filter :haml
+    when "coffee"
+      filter :coffeescript
+    when "sass"
+      filter :sass
+    end
+  end
+end
+
+route '*' do
+  if item.binary?
+    # Write item with identifier /foo/ to /foo.ext
+    item.identifier.chop + '.' + item[:extension]
+  else
+    case item[ :extension ]
+    when "coffee"
+      item.identifier.chop + '.js'
+    when 'sass'
+      item.identifier.chop + '.css'
+    when 'haml'
+      item.identifier + 'index.html'
+    else
+      raise "not sure what to do with #{item}"
+    end
+  end
+end

data/bin/gitoe

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require "sinatra"
+require "gitoe/httpserver/static"
+require "gitoe/httpserver/repos"
+
+handler = \
+  begin
+    require "thin"
+    Rack::Handler::Thin
+  rescue LoadError
+    false
+  end ||
+
+handler ||= \
+  begin
+    require "mongrel"
+    Rack::Handler::Mongrel
+  rescue LoadError
+    false
+  end
+
+handler ||= \
+  Rack::Handler::WEBrick
+
+root = Rack::Builder.new do
+
+  use Rack::Deflater
+  map "/repo" do run Gitoe::HTTPServer::Repos.new  end
+  map "/"     do run Gitoe::HTTPServer::Static.new end
+
+end
+
+root = Rack::Reloader.new(root,cooldown=0) if ENV["RACK_ENV"]=="development"
+
+handler.run root, Port: 12345

data/content/gitoe-draw.coffee

@@ -0,0 +1,342 @@
+$ = jQuery or throw "demand jQuery"
+R = Raphael or throw "demand Raphael"
+
+clone = (obj)->
+  $.extend({},obj)
+
+strcmp = exports.gitoe.strcmp
+
+class DAGLayout
+  # TODO a more proper placement, for
+  #   - less crossing
+  #   - better looking
+  #   want: referencing to position of parents
+  # XXX Maybe re-layouting
+  # XXX Maybe layout in layer --- how to trigger?
+  constructor: (@cb)->
+    # @cb:
+    #   draw_node : ( id, layer, pos )
+
+    # topo
+    @children = {}  # { id: [ children ] }
+    @parents  = {}  # { id: [ parents ] }
+
+    # layout
+    @layer    = {}  # { id : layer }
+    @position = {}  # { id : position }
+    @grid     = {}  # { layer: [ position: id ] }
+    @layer_span = {}# { id : num }
+
+  add_node: ( id, parents )=>
+    @topo( id, parents )
+
+    layer      = @get_layer( id )
+    layer_span = @get_layer_span( id, layer )
+    pos        = @get_position( id, layer, layer_span )
+
+    @cb.draw_node( id, layer, pos, layer_span )
+
+  get_layer: (id)->
+    # layer = 1 + max[ parent.layer ]
+    layer = 0
+    for parent in @parents[id]
+      parent_layer = @layer[parent]
+      if parent_layer >= layer
+        layer = parent_layer + 1
+    @grid[layer] ?= []
+    @layer[id] = layer
+
+  get_layer_span: (id, layer)->
+    layer_span = 1
+    l = {}
+    for parent in @parents[id]
+      parent_layer = @layer[parent]
+      l[parent] = parent_layer
+      if parent_layer + layer_span < layer
+        layer_span = layer - parent_layer
+    @layer_span[id] = layer_span
+
+  get_position: ( id, layer, layer_span )->
+    # first appropriate position,
+    #   which
+    #   - is not occupied, on layers of <id> and all fake nodes
+    #   - TODO and preferably shorten edges
+    position   = -1
+    conflict   = true
+    layers_to_check = [(layer-layer_span+1)..(layer)]
+    grid = @grid
+    while conflict
+      position++
+      occupied = layers_to_check.filter (layer)->
+        grid[layer][position]
+      if occupied.length == 0
+        conflict = false
+
+    for layer in layers_to_check
+      @grid[layer][position] = id
+    @position[id] = position
+
+  topo: ( id, parents )->
+    for parent in parents
+      cs = @children[ parent ]
+      if cs is undefined
+        throw "<#{id}> added before its parent <#{parent}>"
+      else
+        cs.push id
+     if @parents[id]
+      throw "<#{id}> added more than once"
+    @parents[id]  = parents
+    @children[id] = []
+
+  query_parents: (id)=>
+    @parents[id]
+  query_pos: (id)=>{
+    layer  : @layer[id]
+    pos    : @position[id]
+  }
+
+class GitoeCanvas
+  @CONST  : {
+    canvas: {
+      width : 300
+      height: 100
+    }
+    padding_left: 60
+    padding_top : 40
+    outer_width : 80
+    outer_height: 60
+    commit_handle: 10
+    box: {
+      width:  60
+      height: 20
+      radius: 2
+      attr: {
+        fill          : "lightblue"
+        "stroke-width": 2
+        stroke        : 'black'
+      }
+    }
+    text_attr: {
+      'font-family': 'mono'
+      'font-size': 12
+    }
+    path_style: {
+      fill: 'pink'
+      strokeWidth: 3
+    }
+  }
+
+  constructor: ( id_container )->
+    @dag = new DAGLayout(draw_node: @draw_async)
+    @constant = clone GitoeCanvas.CONST
+    @init_canvas( id_container )
+    @objs = {}     # { sha1 : canvas objs }
+    @div = $("##{id_container}")
+    @ref_objs = {} # { ref_name: canvas objs }
+
+  add_commit_async: (commit)=>
+    setTimeout( @add_commit.bind( @, commit )  , 500 )
+
+  draw_async: (sha1, layer, pos)=>
+    setTimeout( @draw.bind( @,sha1,layer,pos ), 0 )
+
+  # TODO
+  # ref_on_commit: (ref)
+  # ref_on_ref:    (ref1, ref2)
+  # destroy: (sha1)->
+    # remove sha1's canvas objects
+
+  add_commit: (commit)->
+    @dag.add_node( commit.sha1, commit.parents )
+
+  draw: (sha1,layer,pos)->
+    if @objs[sha1]
+      @destroy sha1
+    coord = @commit_coord(layer, pos)
+    parents = @dag.query_parents(sha1).map( @dag.query_pos )
+
+    commit_box = @draw_commit_box(coord)
+    text = @draw_commit_text(coord, sha1)
+    paths = @draw_paths(coord, parents)
+    need_focus = !!(@canvas_inc_height(coord.top) + @canvas_inc_width(coord.left) )
+    if need_focus
+      @focus(coord)
+    @objs[sha1] = {
+      commit_box : commit_box
+      text       : text
+      paths      : paths
+    }
+
+  clear_refs: ()->
+    for ref_name, objs of @ref_objs
+      for obj in (objs or [])
+        obj.remove()
+
+  set_refs: (refs)->
+    # refs: { ref_name : [ sha1 ] }
+    @clear_refs()
+    # console.log refs
+
+    ref_names_sorted = Object.keys(refs).sort( strcmp )
+
+    for ref_name, ref_index in ref_names_sorted
+      @ref_objs[ ref_name ] = @draw_ref( ref_index, ref_name, refs[ref_name] )
+
+  draw_ref: ( ref_index, ref_name, sha1s )-> # [ canvas objs ]
+    # TODO
+    sha1_last = sha1s[ sha1s.length - 1 ]
+    p_last = @dag.query_pos(sha1_last)
+    coord_last = @commit_coord( p_last.layer, p_last.pos )
+    @focus @commit_coord( p_last.layer, p_last.pos )
+    [
+      @draw_ref_path( ref_index, sha1s )
+      @draw_ref_text( ref_index, coord_last, ref_name )
+      @draw_ref_pointer( ref_index, coord_last )
+    ]
+
+  draw_ref_pointer: ( ref_index, p_last )->
+    @canvas.path(
+
+    )
+
+  draw_ref_text: ( ref_index, coord_last, ref_name )->
+    console.log ref_index, coord_last, ref_name
+    @canvas.text(
+      coord_last.left + @constant.box.width + (0.6+ref_index) * 30 + ref_name.length * 2,
+      coord_last.top  + @constant.box.height * (1+ref_index)/3
+      ref_name
+    ).attr(@constant.text_attr)
+
+  draw_ref_path: ( ref_index, sha1s, textbox_width )-> # path
+    command_array = []
+    current = prev = null
+    handler_top = @constant.box.height * (1+ref_index)/3
+    for sha1, index in sha1s
+      prev = current
+      current = @commit_coord_by_sha1( sha1 )
+      if index is 0 # first comit in path
+        command_array.push [
+          'M'
+          current.left + @constant.box.width
+          current.top + handler_top
+        ]...
+      else
+        command_array.push [
+          'Q'
+          50 + ref_index * 40 + @constant.box.width + Math.max(current.left, prev.left)
+          (current.top + prev.top)/2 + handler_top - 35
+          @constant.box.width + current.left
+          current.top + handler_top
+        ]...
+    @canvas.path(command_array.join(' '))
+
+  commit_coord: (layer,pos)->{
+    # left and top coord of commit-box
+    left: (@constant.padding_left + @constant.outer_width  * pos)
+    top : (@constant.padding_top  + @constant.outer_height * layer)
+  }
+  commit_coord_by_sha1: (sha1)->
+    p = @dag.query_pos(sha1)
+    @commit_coord( p.layer, p.pos )
+
+  draw_commit_box: (coord)->
+    @canvas.rect(
+      coord.left,
+      coord.top,
+      @constant.box.width,
+      @constant.box.height,
+      @constant.box.radius
+    ).attr(@constant.box.attr)
+
+  draw_commit_text: (coord,sha1)->
+    @canvas.text(
+      coord.left + @constant.box.width/2,
+      coord.top  + @constant.box.height/2,
+      sha1[0..7]
+    ).attr(@constant.text_attr)
+
+  draw_paths: (coord, parents_pos)->
+    paths = []
+    start = [
+      'M'
+      coord.left + @constant.box.width/2
+      coord.top
+    ].join ' '
+    for p in parents_pos
+      coord_p = @commit_coord(p.layer, p.pos)
+      path_command = @path_command(coord, coord_p)
+      if path_command
+        paths.push @canvas.path( start + path_command )
+    paths
+
+  path_command: ( coord, coord_p )->
+    # command string to draw path,
+    # ref http://www.w3.org/TR/SVG/paths.html#PathDataLinetoCommands
+    bottom_of_parent = {
+      x: coord_p.left + @constant.box.width / 2
+      y: coord_p.top  + @constant.box.height
+    }
+    top_of_highest_fake_node = {
+      x: coord.left  + @constant.box.width / 2
+      y: coord_p.top + @constant.outer_height
+    }
+    if coord.left == coord_p.left # same column
+      [
+        'L'
+        bottom_of_parent.x
+        bottom_of_parent.y
+      ].join ' '
+    else
+      vertical_distance = @constant.outer_height - @constant.box.height
+      ratio = 0.3
+      [
+        'L'
+        top_of_highest_fake_node.x
+        top_of_highest_fake_node.y
+        'C'
+        top_of_highest_fake_node.x
+        @mix( top_of_highest_fake_node.y, bottom_of_parent.y , ratio)
+        bottom_of_parent.x
+        @mix( top_of_highest_fake_node.y, bottom_of_parent.y , 1-ratio)
+        bottom_of_parent.x
+        bottom_of_parent.y
+      ].join ' '
+
+  mix: (a,b,ratio)->
+    a*ratio + b*(1-ratio)
+  focus: (coord)->
+    @div.scrollTo {
+      left: coord.left - 200
+      top : coord.top  - 200
+    }
+
+  init_canvas: (id_canvas)->
+    @canvas_size = clone @constant.canvas
+    @canvas = R(
+      id_canvas,
+      @canvas_size.width,
+      @canvas_size.height
+    )
+
+  canvas_inc_width: (left)->
+    if left + @constant.outer_width > @canvas_size.width
+      @canvas_size.width += 1*@constant.outer_width
+      @canvas_resize()
+      true
+    else
+      false
+  canvas_inc_height: (top)->
+    if top + @constant.outer_height > @canvas_size.height
+      @canvas_size.height += 1*@constant.outer_height
+      @canvas_resize()
+      true
+    else
+      false
+  canvas_resize: ()->
+    @canvas.setSize(
+      @canvas_size.width,
+      @canvas_size.height,
+    )
+
+@exports ?= { gitoe: {} }
+exports.gitoe.GitoeCanvas = GitoeCanvas