bzrwrapper 0.1

data/README

@@ -0,0 +1,25 @@
+# == Synopsis
+# easy wrapper to get some information out of bazaar-branches
+# wraps: bzr version-info, bzr log --forward
+# processes the 'log' so you can deal with single 'Commits' that make up the log...
+#
+# == Author
+# Rene Paulokat
+# 
+# == Copyright
+# Copyright (c) 2007 Rene Paulokat
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#

data/lib/bzrwrapper.rb

@@ -0,0 +1,241 @@
+# BzrWrapper is a simple tool to extract information from
+# bazaar-branches (http://bazaar-vcs.org)
+# it gives u the opportunity to extract log/commits/version-info
+#--
+# Author::    rene paulolat (mailto: rene@so36.net)
+# Copyright:: Copyright (c) 2007 rene paulokat
+# License::   
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+# :include: ./README
+
+# == Extract information of bzr-branches 
+# 
+# pp branch = BzrWrapper::Branch.new('/home/rp/devel/rubzr')
+# ->
+## <BzrWrapper::Branch:0x2b7b13335ce8
+#  @path="/home/rp/devel/rubzr",
+#  @version_info=
+#   #<BzrWrapper::Info:0x2b7b133352c0
+#    @branch_nick=" rubzr",
+#    @date=Wed Aug 22 11:22:03 +0200 2007,
+#    @revision_id=" rp@dwarf-20070822092203-xzink973ch9e5d07",
+#    @revno=" 6">>
+#
+# * iterate over the commits
+# branch.log.each_entry { |e| puts e.time.to_s }
+#     -> Tue Aug 21 16:58:29 +0200 2007
+#     -> Tue Aug 21 16:57:22 +0200 2007
+# * get the latest 2 commits 
+# BzrWrapper::Branch.new('/home/rp/devel/rubzr').last_commits(2) { |c| puts c.message + " / " + c.time.to_s }
+#     -> added Info / Tue Aug 21 16:57:22 +0200 2007
+#     -> log-parsing... / Tue Aug 21 21:05:42 +0200 2007
+#
+# == Classes
+# * BzrWrapper::Branch
+# * BzrWrapper::Log
+# * BzrWrapper::Info
+# * BzrWrapper::Commit
+#
+module BzrWrapper
+  require 'time'
+  
+  # represents bazaar-branch
+  #
+  class Branch
+  
+    # filepath to the bazaar-branch
+    attr_reader :path
+    # returns BzrWrapper::Info 
+    attr_reader :version_info
+    
+    # initiate instance with path to existent 
+    # bazaar-branch
+    # :call-seq: 
+    #     BzrWrapper::Branch.new('/your/path/to/branch')    -> BzrWrapper::Branch
+    #
+    def initialize(path)
+      unless File.exist?(path) && File.readable?(path)
+        raise ArgumentError, "no such file / not readable: #{path}"
+      end
+      begin
+        Branch.is_branch?(path)
+      rescue BzrException => e
+        puts "no branch: #{e}"
+        exit 0
+      end
+      @path = path
+      @version_info = create_info
+    end
+    
+    # returns BzrWrapper::Log
+    #
+    def log
+      @log || create_log
+    end
+    
+    # checks if given 'path' is a bazaar-branch
+    #
+    def Branch.is_branch?(path)
+      Dir.chdir(path) do |branch|
+        IO.popen('bzr version-info') do |io| 
+          if io.gets.nil?
+            raise BzrException, "Not ab branch: #{path}"
+          else
+            return true
+          end
+        end
+      end
+    end
+    
+    # returns last _num_ Commit's or
+    # yields commit if block given
+    #
+    def last_commits(num,&block)
+      x = -num
+      block_given? ? log.commits[x..-1].each { |commit| yield commit }  : log.commits[x..-1]
+    end
+    
+    private 
+    
+    # wraps system-call 'bzr version-info'
+    # and creates BzrWrapper::Info 
+    #
+    def create_info
+      Dir.chdir(@path) do |path|
+        arr = []
+        hash = {}
+        IO.popen('bzr version-info') do |io|
+          unless io.eof?
+            io.readlines.each do |line|
+                k , v = line.split(':',2)
+                hash[k] = v
+            end
+          end
+        end
+        ['date','revno','branch-nick','revision-id'].each { |x| raise BzrException.new("no such info-key:: #{x}")  unless hash.has_key?(x)  }
+        return Info.new(hash['date'], hash['revno'], hash['branch-nick'], hash['revision-id'])
+      end
+    end
+    
+    # wraps system-call 'bzr log --forward'
+    # and returns BzrWrapper::Log
+    #
+    def create_log(forward=true,start=1, stop=-1)
+      @entries = []
+      cmd = "bzr log "
+      cmd << "--forward " if forward
+      cmd << "-r" << start.to_s << ".." << stop.to_s
+      Dir.chdir(@path) do 
+        offsets = []
+        arr = IO.popen(cmd).readlines
+        arr.each_index { |x| offsets.push(x) if arr[x].strip.chomp == Log::SEPARATOR  }
+        while not offsets.empty?
+          hash = {}
+          start = @_tmp || offsets.shift
+          stop = if offsets.empty? 
+                  -1
+                 else 
+                  @_tmp = offsets.shift
+                  @_tmp
+                 end
+          _arr = arr[start..stop]
+          _arr.each_index { |x| _arr.delete_at(x) if _arr[x].strip.chomp == Log::SEPARATOR }
+          _arr.each_with_index do |line,i| 
+            if line.match('message:') 
+              hash['message'] = _arr[i+1].chomp.strip unless _arr[i+1].nil?
+            else
+              line.gsub!('branch nick:', 'branch_nick:') if line.match('branch nick:') 
+              ['revno:','committer:','branch_nick:','timestamp:','merged:'].each do |thing|
+                if line.match(thing)
+                  hash[line.split(':',2)[0].chomp.strip] = line.split(':',2)[1].chomp.strip
+                end
+              end
+            end
+          end
+          @entries.push(Commit.new(hash['revno'],hash['committer'], hash['branch_nick'], hash['timestamp'], hash['message'],hash['merged']))
+        end
+      end
+      @log = Log.new(@entries)
+    end
+  end
+  
+  # class representing status-information of given bazaar-branch
+  #
+  class Info
+    # date of last commit
+    attr_reader :date 
+    # latest revision-number
+    attr_reader :revno
+    # name/nick of the branch
+    attr_reader :branch_nick
+    # latest revision-id
+    attr_reader :revision_id
+    
+    def initialize(date_string, revision, nick, revision_id)
+      @date,@revno,@branch_nick, @revision_id = Time.parse(date_string.chomp.strip), revision.chomp, nick.chomp, revision_id.chomp
+    end
+    
+    def to_s
+      "revision: #{@revno} | date: #{@date.to_s} | branch-nick: #{@branch_nick} | revision-id: #{@revision_id}"
+    end
+  end
+  
+  # represents the branch-log
+  # with <n> 'Commit's
+  #
+  class Log
+    SEPARATOR = '------------------------------------------------------------'
+    # num of log-entries 
+    attr_reader :count
+    # array of BzrWrapper::Commit's of this BzrWrapper::Log
+    attr_reader :commits
+    
+    def initialize(le_array, &block)
+      @count = le_array.length
+      @commits = le_array
+      block_given? ? @commits.each { |x| yield x }  : self
+    end
+    
+    # Iterates over supplied Commits.
+    def each_entry
+      block_given? ? @commits.each { |c| yield c } : @commits
+    end
+
+  end
+  
+  # represents single commit / checkin
+  # 
+  class Commit
+    attr_reader :revno, :committer, :branch_nick, :timestamp, :message, :merged
+    
+    def initialize(revno,committer,branch_nick,timestamp,message,merged=nil)
+      @revno,@committer,@branch_nick,@timestamp,@message,@merged = revno,committer,branch_nick,timestamp,message,merged
+    end
+    
+    # returns time-object of this commit
+    #
+    def time
+      Time.parse(@timestamp)
+    end
+    
+  end
+  
+  class BzrException < Exception
+  end
+  
+end
+#include BzrWrapper

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: bzrwrapper
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+date: 2007-08-24 00:00:00 +02:00
+summary: "Wrapper for bazaar-vcs to extract information of bazaar-branches / see: http://bazaar-vcs.org"
+require_paths: 
+- lib
+email: rene@so36.net
+homepage: http://oopen.de
+rubyforge_project: 
+description: 
+autorequire: bzrwrapper
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Rene Paulokat
+files: 
+- lib/bzrwrapper.rb
+- README
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+