grudge 0.1.0

data/HISTORY.txt

@@ -0,0 +1,2 @@
+== 0.1.0 / 2008-10-22
+  * First of many versions

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Justin Knowlden
+
+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.markdown

@@ -0,0 +1,108 @@
+# Grudge
+
+Grudge is a stand-alone system, which means you run it on your own, that watches the comments of some git repository and provides a web interface to allow people to rate the comments.
+
+## Why would someone want to do this?
+
+In my experience, code commit comments have been very funny; or at least very good reads. It's kind of an insight into some of the programmer's minds. At one point, I was scouring the commit comments and sending a daily email of the ones I thought were funny. The emails were well received, so I figured there must be something to this.
+
+Thus, the goals are:
+
+1. Make people laugh
+2. Inform others - besides those in development - of the day-to-day
+
+I also hope that something like this will make for better commit comments; since you know you are now being watched ... and judged.
+
+## Why is it called Grudge?
+
+Well, basically I typed 'rate' into Apple's thesaurus app and noticed the word 'judge'. I wanted to add a 'G' to the front of the app - since this is a git commit watcher - and so hit upon 'grudge'.
+
+Alas, Grudge = Git Judge
+
+## How does it work?
+
+Once your system is bootstrapped, grudge will monitor for updates. For each commit, grudge will store the SHA hash of the commit-id (for referential reasons) and the date it was committed (for ordering reasons). Commit messages and other commit data (like author) stay in the git repository and are always retrieved from there; even at a possible speed reduction (though grudge seems pretty quick).
+
+Each vote is recorded for a commit as either a +1 or a -1. Votes are themselves entities, which means you could get the voting history for any commit.
+
+Commits have a net score, which is simply the sum of all of the votes. Popular commits are those with the highest net score. Unpopular are those with the lowest net score.
+
+# Using Grudge
+
+## Requirements
+
+* [Sinatra](http://github.com/bmizerany/sinatra/tree/master)
+* [Ruby Git](http://github.com/schacon/ruby-git/tree/master)
+* [HAML](http://haml.hamptoncatlin.com/)
+* [Sqlite3-ruby](http://github.com/jamis/sqlite3-ruby/tree/master)
+
+* DataMapper - `sudo gem install data_mapper`
+* DataObjects - `sudo gem install data_objects` ... *if not already installed*
+* DataObject bindings for Sqlite - `sudo gem install do_sqlite3`
+* JSON Pure - `sudo gem install json_pure` - annoyingly needed by data_mapper
+
+## Setting up an app
+
+### Install the gem
+
+    $ sudo gem install thumblemonks-grudge
+
+### Setup an instance
+
+    $ mkdir foo && cd foo
+    $ grudge init
+
+### Tell Grudge about your repository
+
+Edit the file in your Grudge instance called `config/grudge.yml`. In it edit the git repository url that you want Grudge to watch. For now, do this for both development and production entries. You don't need to edit anything else, unless you just can't help yourself.
+
+Example:
+
+    ...
+    repository:
+      url: git://github.com/thumblemonks/grudge.git
+    ...
+
+### Run the app
+
+When just playing around, you can run:
+
+    $ grudge start
+
+This will first clone the remote repository you defined, bootstrap the commits in a local Sqlite database, then run the Sinatra web-app. As long as you don't remove `clone.git`, the cloning will only happen on the first run. Grudge will, however, grab new updates from the repo each time you start it.
+
+Point your browser at `http://localhost:9292/` and you are done.
+
+Oh yeah ... advertise it!
+
+#### Phusion
+
+It is suggested that you run grudge through Apache via [Phusion Passenger](http://www.modrails.com/). In order to do this, simply point a configured Phusion Virtual Host at the `public` directory wherever you ran `grudge init`.
+
+### Getting automatic updates
+
+As of this writing the way to tell Grudge to automatically look for updates is to setup a remote repository via a post-receive hook. This means your instance of Grudge will need to be routable by your git server.
+
+If this is so, just setup a post-receive hook to hit the URL with a POST request:
+
+    http(s)://your-grudge-instance/repository/pull
+
+#### Manual updates
+
+You can update manually by either restarting the app or via the Grudge console like so:
+
+    $ grudge pull
+
+You could also setup a bash alias like the following:
+
+    wget -q --post-data='\'''\'' --no-cookies --delete-after http://your-grudge-instance/repository/pull
+
+Not that I did that ;)
+
+# Acknowledgements
+
+Someone for sure. I guess my [wife](http://lesfeministes.com) for giving me the Saturday to write this.
+
+# Legal
+
+Copyright © 2008 Justin Knowlden, released under the MIT license

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'lib/boot'
+
+desc 'Default task: run all tests'
+task :default => [:test]
+
+desc 'Run all tests'
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/boot.rb"
+end

data/TODO.markdown

@@ -0,0 +1,27 @@
+# Todo
+
+## 0.1.0
+
+* Get it started
+* Make it a gem
+* Command line options
+* Make grudge start in production mode as a policy ;)
+
+## Backlog
+
+* Effective logging - not sure if logging git transactions is enough
+* Paging: so we can see more commits
+* Only allow one vote per person (maybe, honesty is often the best policy)
+  * [Dan Hodos](http://github.com/danhodos) proved to me that honesty just sucks
+* Allow users to add tags
+  * Show results by tag
+* Allow users to comment on commits
+  * Allow users to filter commits based on whether they were commented-on/rated
+* RSS feeds
+  * Especially for tags
+* UJS
+* Ask for local/remote git repo URI on command line and pre-bootstrap
+* Might name Suck to Boring
+* Sparkline of voting history
+* Handle branches
+* Move away from DataMapper unless it gets better support?

data/bin/grudge

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+Signal.trap("INT") { puts "Exiting grudge"; exit } # If we need it
+
+def usage
+  $stderr.puts "Usage: grudge [init|start|pull]"
+end
+
+def fire_up
+  require File.join(File.dirname(__FILE__), '..', 'lib', 'boot')
+  Grudge::Config.fire_me_up(:production)
+  Grudge::Database.fire_me_up
+  Grudge::Repository.open_or_clone
+end
+
+def mkdir(dir)
+  if File.exists?(dir)
+    puts "- Existing directory #{dir} untouched"
+  else
+    puts "- Creating directory #{dir}"
+    FileUtils.mkdir(dir)
+  end
+end
+
+def cp_grudge_file(src, dest)
+  unless File.exists?(dest)
+    puts "- Copying grudge file #{src} to #{dest}"
+    FileUtils.cp(File.join(File.dirname(__FILE__), src), dest)
+  else
+    puts "- Existing file #{dest} untouched"
+  end
+end
+
+if ARGV.length == 1
+  case ARGV.shift
+  when 'start'
+    puts "Starting grudge ... but, why not just use Phusion with Rack?"
+    app = File.join(File.dirname(__FILE__), '..', 'lib', 'grudge.rb')
+    %x[rackup config.ru]
+  when 'pull'
+    puts "Pulling latest commits"
+    fire_up
+    Commit.download!
+  when 'init'
+    puts "Initializing grudge instance"
+    %w[public tmp config].each { |dir| mkdir("./#{dir}") }
+    cp_grudge_file('../config/grudge.yml', './config/grudge.yml')
+    cp_grudge_file('../config.ru', './config.ru')
+  else
+    usage
+  end
+else
+  usage
+end

data/config.ru

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rack'
+require 'sinatra'
+
+Sinatra::Application.default_options.update(
+  :run => false,
+  :env => :production,
+  :raise_errors => true
+)
+
+require 'grudge'
+
+run Sinatra.application

data/config/grudge.yml

@@ -0,0 +1,31 @@
+#
+# Database entries feed directly into DataMapper.setup
+#
+production:
+  log: 'grudge.log'
+  database:
+    adapter: 'sqlite3'
+    database: 'grudge.db'
+  repo:
+    master: 'clone.git'
+    #
+    # Hey you! You should change only this setting
+    origin: 'git://example.com/repository.git'
+
+#
+# You don't need to change anything below here
+test:
+  log: '/dev/null'
+  database: 'sqlite3::memory:'
+  repo:
+    master: 'test/clone.git'
+    origin: 'test/origin.git'
+
+development:
+  log: 'grudge_development.log'
+  database:
+    adapter: 'sqlite3'
+    database: 'grudge_development.db'
+  repo:
+    master: 'clone.git'
+    origin: 'git://example.com/repository.git'

data/grudge.gemspec

@@ -0,0 +1,64 @@
+Gem::Specification.new do |s|
+  s.name     = "grudge"
+  s.version  = "0.1.0"
+  s.date     = "2008-10-22"
+  s.summary  = "Grudge is a git commit comment judging web-app"
+  s.email    = "gus@gusg.us"
+  s.homepage = "http://github.com/thumblemonks/grudge"
+  s.description = "Grudge is a stand-alone system, which means you run it on your own, that watches the comments of some git repository and provides a web interface to allow people to rate the comments."
+  s.authors  = ["Justin Knowlden"]
+
+  s.bindir = "bin"
+  s.executables = ["grudge"]
+  s.default_executable = "grudge"
+
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["HISTORY.txt", "README.markdown"]
+
+  s.add_dependency("sinatra", [">= 0.3.1"])
+  s.add_dependency("git", [">= 1.0.5"])
+  s.add_dependency("haml", [">= 2.0.3"])
+  s.add_dependency("sqlite3-ruby", [">= 1.2.4"])
+  s.add_dependency("data_mapper", [">= 0.9.7"])
+  s.add_dependency("data_objects", [">= 0.9.7"])
+  s.add_dependency("do_sqlite3", [">= 0.9.7"])
+  s.add_dependency("json_pure", [">= 1.1.3"]) # datamapper! grrr
+
+  # run git ls-files to get an updated list
+  s.files = %w[
+    HISTORY.txt
+    MIT-LICENSE
+    README.markdown
+    Rakefile
+    TODO.markdown
+    bin/grudge
+    config.ru
+    config/grudge.yml
+    grudge.gemspec
+    lib/boot.rb
+    lib/grudge.rb
+    lib/grudge/base.rb
+    lib/grudge/config.rb
+    lib/grudge/database.rb
+    lib/grudge/extensions.rb
+    lib/grudge/helpers.rb
+    lib/grudge/repository.rb
+    lib/models/commit.rb
+    lib/models/vote.rb
+    lib/views/application.haml
+    lib/views/application.sass
+    lib/views/index.haml
+    lib/views/not_found.haml
+    lib/views/show.haml
+  ]
+  s.test_files = %w[
+    test/commit_test.rb
+    test/config_test.rb
+    test/grudge_test.rb
+    test/model_factory.rb
+    test/repository_test.rb
+    test/test_helper.rb
+    test/vote_test.rb
+  ]
+end

data/lib/boot.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+
+# TODO: Move to Kernel or something
+def require_local_lib(pattern)
+  Dir.glob(File.join(File.dirname(__FILE__), pattern)).each {|f| require f }
+end
+require_local_lib('grudge/*.rb')
+require_local_lib('models/*.rb')

data/lib/grudge.rb

@@ -0,0 +1,73 @@
+require File.join(File.dirname(__FILE__), 'boot')
+require 'sinatra'
+
+# Configuration
+
+configure(:development, :test) { require 'ruby-debug' }
+
+configure do
+  set_option :views, File.join(File.dirname(__FILE__), 'views')
+  set_option :public, File.join(File.dirname(__FILE__), 'public')
+  Grudge::Config.fire_me_up(Sinatra.env)
+  Grudge::Database.fire_me_up
+end
+
+configure :development, :production do
+  Grudge::Repository.open_or_clone
+  Commit.download!
+end
+
+# Setup
+
+include Grudge::Sinatra::Extensions
+
+catch_all_css
+template(:layout) {:application}
+not_found {haml :not_found}
+
+helpers do
+  include Grudge::Sinatra::Helpers
+end
+
+# Top-level actions
+
+get("/") { redirect '/recent' }
+
+%w[recent popular unpopular].each do |scope|
+  get "/#{scope}" do
+    set_title("#{scope.to_s.capitalize} commits")
+    @commits = Commit.send(scope)
+    haml :index
+  end
+end
+
+%w[awesome suck].each do |vote|
+  get "/:sha/#{vote}" do
+    commit = Commit.first(:sha => params[:sha])
+    raise Sinatra::NotFound unless commit
+    commit.send("#{vote}!")
+    redirect "/#{commit.sha}"
+  end
+end
+
+get '/:sha' do
+  show_commit(Commit.first(:sha => params[:sha]))
+end
+
+# TODO: search across all sorts of fields; not just commit id
+post '/search' do
+  show_commit(Commit.search(params['query'].to_s))
+end
+
+post '/repository/pull' do
+  Commit.download!
+end
+
+private
+
+  def show_commit(commit)
+    raise Sinatra::NotFound unless commit
+    @commit = commit
+    set_title(commit.sha)
+    haml :show
+  end

data/lib/grudge/base.rb

@@ -0,0 +1,16 @@
+module Grudge
+  VERSION = '0.1.0'
+  module Hash
+    def symbolize_keys
+      self.mash { |k,v| {k.to_sym => v} }
+    end
+  end
+end # Grudge
+
+module Enumerable
+  def mash
+    self.inject({}) { |a,i| a.merge( yield(i) ) }
+  end
+end # Enumerable
+
+Hash.send(:include, Grudge::Hash)