RubyGems - znz-gitpub - Versions diffs - 0.1.0 - Mend

znz-gitpub 0.1.0

Files changed (5) hide show

data/README ADDED

@@ -0,0 +1,5 @@
+GitPub
+Web application to publish static files based on git and rack.
+Pub means 'publish' and supporting only static files like publicfile of DJB.

data/gitpub.rb ADDED

@@ -0,0 +1,219 @@
+#!/usr/bin/ruby
+# -*- coding: utf-8 -*-
+# = gitpub.rb
+#
+# Web application to publish static files based on git and rack.
+#
+# Pub means 'publish' and supporting only static files like publicfile of DJB.
+#
+# == Example Usage
+#
+# execute some commands:
+#  gem install rack
+#  git clone git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux-2.6.git
+#  rackup -d linux-2.6.ru
+# and open http://localhost:9292/ with your browser.
+#
+# linux-2.6.ru is:
+#  require 'gitpub'
+#  run GitPub.new('linux-2.6/.git', /\Av2\.6\.\d+\z/)
+#
+#
+# == License (The MIT License)
+#
+# Copyright (c) 2009 Kazuhiro NISHIYAMA
+#
+# 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.
+#
+require 'erb'
+require 'rack/mime'
+class GitPub
+  include ERB::Util
+  # path to git command
+  GIT_BIN = "git"
+  # Create GitPub instance.
+  #
+  # git_dir :: path to .git or git bare repository.
+  # pub_tag_regexp :: Regexp of publish tag.
+  #                   Recommends use \A and \z instead of ^ and $.
+  # title :: HTML title prefix. Default is repository's directory name.
+  def initialize(git_dir, pub_tag_regexp=/\A([^\/:]+)\z/, title=nil)
+    @git_dir = git_dir
+    @pub_tag_regexp = pub_tag_regexp
+    unless title
+      title = File.basename(git_dir)
+      if title == ".git"
+        title = File.basename(File.dirname(git_dir))
+      end
+    end
+    @title = title
+  end
+  # Wrapper of git command.
+  def git(*args)
+    IO.popen("-", "r") do |io|
+      if io
+        yield io
+      else
+        #STDERR.puts [GIT_BIN, "--git-dir", @git_dir, *args].inspect
+        exec(GIT_BIN, "--git-dir", @git_dir, *args)
+      end
+    end
+  end
+  private :git
+  # List public tags.
+  def list_pub_tag(env, res)
+    tags = []
+    git("tag") do |io|
+      io.each_line do |line|
+        line.chomp!
+        if @pub_tag_regexp =~ line
+          tags << $&
+        end
+      end
+    end
+    tags.sort!
+    E_list_pub_tag.result(binding)
+  end
+  # ERB template of list_pub_tag.
+  E_list_pub_tag = ERB.new(<<-ERUBY, 1, '-')
+<html>
+<head>
+<title><%=h @title %></title>
+</head>
+<body>
+<h1><%=h @title %></h1>
+<ul>
+<%- tags.each do |tag| -%>
+<li><a href="<%=h tag %>/"><%=h tag %></a></li>
+<%- end -%>
+</ul>
+</body>
+</html>
+  ERUBY
+  # List files in the blob (tag or directory)
+  def list_files(env, res, tag, path)
+    files = []
+    git("ls-tree", "-z", "#{tag}:#{path}") do |io|
+      io.each_line("\0") do |line|
+        line.chomp!("\0")
+        #STDERR.puts line
+        info, file = line.split(/\t/, 2)
+        mode, type, object = info.split(/ /)
+        files << {
+          :mode => mode,
+          :type => type,
+          :object => object,
+          :file => file,
+        }
+      end
+    end
+    files = files.sort_by{|h| h[:file] }
+    E_list_files.result(binding)
+  end
+  # ERB template of list_files.
+  E_list_files = ERB.new(<<-ERUBY, 1, '-')
+<html>
+<head>
+<title><%=h @title %> <%=h tag %>:<%=h path %></title>
+</head>
+<body>
+<h1><%=h @title %> <%=h tag %>:<%=h path %></h1>
+<ol>
+<li><a href="..">..</a></li>
+<%- files.each do |h| -%>
+  <%- case h[:type] -%>
+  <%- when "tree" -%>
+<li><a href="<%=h h[:file] %>/"><%=h h[:file] %>/</a></li>
+  <%- when "blob" -%>
+<li><a href="<%=h h[:file] %>"><%=h h[:file] %></a></li>
+  <%- else -%>
+<li><%=h h[:file] %></li>
+  <%- end -%>
+<%- end -%>
+</ol>
+</body>
+</html>
+  ERUBY
+  # Show file content of object.
+  # Content-Type choose by Rack::Mime.mime_type of file extension.
+  # Default is text/plain.
+  def show_file(env, res, tag, path)
+    body = "(empty)"
+    git("show", "#{tag}:#{path}") do |io|
+      body = io.read
+    end
+    mime_type = Rack::Mime.mime_type(File.extname(path), "text/plain")
+    if mime_type != "text/plain"
+      res.write body
+      res['Content-Type'] = mime_type
+      res['Content-Length'] = (body.bytesize rescue body.size).to_s
+      return
+    end
+    E_show_file.result(binding)
+  end
+  # ERB template of show_file.
+  E_show_file = ERB.new(<<-ERUBY, 1, '-')
+<html>
+<head>
+<title><%=h @title %> <%=h tag %>:<%=h path %></title>
+</head>
+<body>
+<h1><%=h @title %> <%=h tag %>:<%=h path %></h1>
+<p><a href=".">back</a><p>
+<pre><%=h body %></pre>
+</body>
+</html>
+  ERUBY
+  # Rack interface.
+  def call(env)
+    res = Rack::Response.new
+    body = nil
+    if /\A\/([^\/:]+)\// =~ env['PATH_INFO']
+      tag, rest = $1, $'
+    end
+    if tag && @pub_tag_regexp =~ tag
+      if /\/\z/ =~ env['PATH_INFO']
+        body = list_files(env, res, tag, rest)
+      else
+        body = show_file(env, res, tag, rest)
+      end
+    else
+      body = list_pub_tag(env, res)
+    end
+    if body
+      res.write body
+      res['Content-Type'] = 'text/html; charset=utf-8'
+      res['Content-Length'] = (body.bytesize rescue body.size).to_s
+    end
+    res.finish
+  end
+end

data/gitpub_spec.rb ADDED

@@ -0,0 +1,208 @@
+# -*- coding: utf-8 -*-
+#!/usr/bin/env spec
+require "gitpub"
+require "rack"
+require "tempfile"
+describe GitPub, "with linux-2.6" do
+  before do
+    @git_dir = File.expand_path("linux-2.6/.git")
+  end
+  it "list all tags without PATH_INFO" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res = gitpub.call({'PATH_INFO' => nil})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list all tags with PATH_INFO=/" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res0 = gitpub.call({'PATH_INFO' => nil})
+    code, headers, res1 = gitpub.call({'PATH_INFO' => "/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    res0.body.should == res1.body
+    body = res1.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list all tags with PATH_INFO=/invalid-tag" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res0 = gitpub.call({'PATH_INFO' => nil})
+    code, headers, res1 = gitpub.call({'PATH_INFO' => "/invalid-tag"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    res0.body.should == res1.body
+    body = res1.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list no files with PATH_INFO=/invalid-tag/" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res0 = gitpub.call({'PATH_INFO' => nil})
+    temp_stderr = Tempfile.new("stderr")
+    orig_stderr = STDERR.dup
+    STDERR.reopen(temp_stderr)
+    code, headers, res1 = gitpub.call({'PATH_INFO' => "/invalid-tag/"})
+    STDERR.reopen(orig_stderr)
+    temp_stderr.rewind
+    error = temp_stderr.read
+    temp_stderr.close
+    error.should == "fatal: Not a valid object name invalid-tag:\n"
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    res0.body.should_not == res1.body
+    body = res1.body.to_s
+    /\.\./.should =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list pub tags only without PATH_INFO" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res = gitpub.call({'PATH_INFO' => nil})
+    all_tags_length = headers["Content-Length"].to_i
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => nil})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    headers["Content-Length"].to_i.should < all_tags_length
+    body = res.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list pub tags only with PATH_INFO=/" do
+    gitpub = GitPub.new(@git_dir)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/"})
+    all_tags_length = headers["Content-Length"].to_i
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    headers["Content-Length"].to_i.should < all_tags_length
+    body = res.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list pub tags with PATH_INFO=/invalid-tag/" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res0 = gitpub.call({'PATH_INFO' => nil})
+    code, headers, res1 = gitpub.call({'PATH_INFO' => "/invalid-tag/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    res0.body.should == res1.body
+    body = res1.body.to_s
+    /\.\./.should_not =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list no files with PATH_INFO=/v2.6.10/" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    temp_stderr = Tempfile.new("stderr")
+    orig_stderr = STDERR.dup
+    STDERR.reopen(temp_stderr)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.10/"})
+    STDERR.reopen(orig_stderr)
+    temp_stderr.rewind
+    error = temp_stderr.read
+    temp_stderr.close
+    error.should == "fatal: Not a valid object name v2.6.10:\n"
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    res.body.to_s.scan(/<li>/).size.should == 1
+    body = res.body.to_s
+    /\.\./.should =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list files with PATH_INFO=/v2.6.11/" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.11/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    body.scan(/<li>/).size.should > 1
+    /\.\./.should =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "list files with PATH_INFO=/v2.6.11/" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.11/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    body.scan(/<li>/).size.should > 1
+    /\.\./.should =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "show file with PATH_INFO=/v2.6.11/COPYING" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.11/COPYING"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    /<pre>/.should =~ body
+    /GNU GENERAL PUBLIC LICENSE/.should =~ body
+  end
+  it "list files with PATH_INFO=/v2.6.11/Documentation/" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.11/Documentation/"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    body.scan(/<li>/).size.should > 1
+    /\.\./.should =~ body
+    /<pre>/.should_not =~ body
+  end
+  it "show file with PATH_INFO=/v2.6.11/Documentation/CodingStyle" do
+    gitpub = GitPub.new(@git_dir, /\Av2\.6\.\d+\z/)
+    code, headers, res = gitpub.call({'PATH_INFO' => "/v2.6.11/Documentation/CodingStyle"})
+    code.should == 200
+    headers["Content-Type"].should == "text/html; charset=utf-8"
+    headers["Content-Length"].should be_instance_of String
+    headers["Content-Length"].to_i.should > 0
+    body = res.body.to_s
+    /<pre>/.should =~ body
+    /Linux kernel coding style/.should =~ body
+  end
+end

data/linux-2.6.ru ADDED

@@ -0,0 +1,3 @@
+# -*- mode: ruby; coding: utf-8 -*-
+require 'gitpub'
+run GitPub.new('linux-2.6/.git', /\Av2\.6\.\d+\z/)

metadata ADDED

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: znz-gitpub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuhiro NISHIYAMA
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-01-30 00:00:00 -08:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    version:
+description:
+email: zn@mbf.nifty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- gitpub.rb
+- gitpub_spec.rb
+- linux-2.6.ru
+has_rdoc: true
+homepage: http://github.com/znz/gitpub
+post_install_message:
+rdoc_options: []
+require_paths: .
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 2
+summary: web application to publish static files based on git and rack
+test_files: []