gitfeed 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Scott Wheeler
+
+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.rdoc

@@ -0,0 +1,59 @@
+= gitfeed
+
+Produces an RSS v2 XML stream for a Git repository.  Can be used inline in an
+application or as a stand-alone server.
+
+== Usage
+
+Gitfeed can be used inline in an application to produce a string with the RSS
+commits:
+
+  require 'rubygems'
+  require 'gitfeed'
+
+  gf = Gitfeed.new('/home/git/repository')
+  puts gf.feed
+
+It can also be used as a standalone server inside of an application:
+
+  require 'rubygems'
+  require 'gitfeed'
+
+  Gitfeed::Server.start('/home/git/repository')  
+
+Or it can be used on the command line:
+
+  gitfeed /home/git/repository
+
+== Customizing the output
+
+You can specify a Haml file to be used for each entry, the default is:
+  /  
+  %p
+    %strong Author:
+    = entry.author.name
+    <
+    %a{ :href => "mailto:#{entry.author.email}" }
+      = entry.author.email
+    >
+  %p
+    %strong Date:
+    = entry.author.date
+  %p
+    %strong Message:
+    = entry.message
+  %p
+    %strong SHA:
+    = entry.objectish
+  - if @include_diffs && !entry.parents.empty?
+    %pre
+      = @git.diff(entry.parents.first.objectish, entry.objectish)
+
+This can be passed as a configuration option either to the construtor, server
+or command line:
+
+  gitfeed --template=template.haml /home/git/repository
+
+== Copyright
+
+Copyright (c) 2010 Scott Wheeler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gitfeed"
+    gem.summary = %Q{Git to RSS converter and optional stand-alone server}
+    gem.description = %Q{Ruby gem to create RSS feeds from commits in a Git stream and an optional Sinatra based server}
+    gem.email = "wheeler@kde.org"
+    gem.homepage = "http://github.com/scotchi/gitfeed"
+    gem.authors = ["Scott Wheeler"]
+    gem.add_dependency "sinatra"
+    gem.add_dependency "haml"
+    gem.add_dependency "git"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gitfeed #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/gitfeed

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gitfeed'
+
+unless ARGV.size >= 1
+  warn <<END
+Usage: gitfeed [options] /path/to/git/repository
+
+Options:
+    --title="RSS Feed Title"
+    --url=http://base.url.com/
+    --description="RSS Feed Descrption"
+    --template=/path/to/haml/template/for/entries
+    --include-diffs=false
+END
+  exit! 1
+end
+
+options = {}
+
+until ARGV.size <= 1 do
+  kv = ARGV.shift.split('=')
+  key = kv.first.sub(/^--/, '').gsub('-', '_').to_sym
+  value = kv.last
+  value = false if value == 'false'
+  value = true if value == 'true'
+  options[key] = value
+end  
+
+repository = ARGV.shift
+
+Gitfeed::Server.start(repository, options)
+

data/lib/entry.haml

@@ -0,0 +1,19 @@
+%p
+  %strong Author:
+  = entry.author.name
+  <
+  %a{ :href => "mailto:#{entry.author.email}" }
+    = entry.author.email
+  >
+%p
+  %strong Date:
+  = entry.author.date
+%p
+  %strong Message:
+  = entry.message
+%p
+  %strong SHA:
+  = entry.objectish
+- if @include_diffs && !entry.parents.empty?
+  %pre
+    = @git.diff(entry.parents.first.objectish, entry.objectish)

data/lib/gitfeed.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'git'
+require 'haml'
+require 'rss/maker'
+require 'sinatra'
+
+# A Git to RSS converter
+
+class Gitfeed
+
+  RSS_VERSION = '2.0'
+
+  # Creates a Gitfeed instance for a specific Git repository where each change
+  # is an RSS entry.
+  #
+  # @param [String] repository_path Path to a Git repository
+  # @param [Hash] options Options for the created RSS feed
+  #
+  # @option options [String] :title ("Gitfeed for Repository")
+  #  Title for the RSS feed
+  # @option options [String] :url ("http://github.com/scotchi.net/gitfeed")
+  #  Base URL for the RSS feed and all links
+  # @option options [String] :description (repository_path)
+  #  Description of the RSS feed
+  # @option options [String] :template ("entry.haml")
+  #  Path to a Haml template for the individual entries
+  # @option options [Boolean] :include_diffs (true)
+  #  Include diffs in the RSS output
+
+  def initialize(repository_path, options = {})
+    @git = Git.open(repository_path)
+    @title = options[:title] || "Gitfeed for #{repository_path.sub(/.*\//, '')}"
+    @url = options[:url] || 'http://github.com/scotchi/gitfeed'
+    @description = options[:description] || repository_path
+    @template = options[:template] || File.expand_path('../entry.haml',  __FILE__)
+    @include_diffs = options[:include_diffs].nil? ? true : options[:include_diffs]
+    @haml = Haml::Engine.new(File.read(@template))
+  end
+
+  # @return [String] An RSS v2 XML stream of the most recent git commits
+
+  def feed
+    RSS::Maker.make(RSS_VERSION) do |maker|
+      maker.channel.title = @title
+      maker.channel.link = @url
+      maker.channel.description = @description
+      maker.items.do_sort = true
+      @git.log(20).each do |entry|
+        item = maker.items.new_item
+        item.title = entry.message.sub(/\n.*/m, '')
+        item.link = @url
+        item.date = entry.date
+        item.description = description(entry)
+      end
+    end.to_s
+  end
+
+  # A Sinatra-based stand-alone server that serves up an RSS feed of the
+  # changes in the specified repository.
+
+  class Server < Sinatra::Base
+
+    # Starts a standalone server. The arguments are identical to Gitfeed.new
+
+    def self.start(*args)
+      @@gitfeed = Gitfeed.new(*args)
+      get '/' do
+        content_type('text/xml')
+        @@gitfeed.feed
+      end
+      self.run!
+    end
+  end
+
+  private
+
+  def description(entry)
+    @haml.render(self, :entry => entry)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gitfeed'
+
+class Test::Unit::TestCase
+end

data/test/test_gitfeed.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGitfeed < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: gitfeed
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Scott Wheeler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-21 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Ruby gem to create RSS feeds from commits in a Git stream and an optional Sinatra based server
+email: wheeler@kde.org
+executables: 
+- gitfeed
+- gitfeed~
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/gitfeed
+- lib/entry.haml
+- lib/gitfeed.rb
+- test/helper.rb
+- test/test_gitfeed.rb
+- bin/gitfeed~
+has_rdoc: true
+homepage: http://github.com/scotchi/gitfeed
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Git to RSS converter and optional stand-alone server
+test_files: 
+- test/helper.rb
+- test/test_gitfeed.rb